在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)

CLI

从版本 4.3.0 开始,PHP 提供了一种新类型的 CLI SAPI(Server Application Programming Interface,服务端应用编程端口)支持,名为 CLI,意为 Command Line Interface,即命令行接口。顾名思义,该 CLI SAPI 模块主要用作 PHP 的开发外壳应用。

CLI运行PHP代码

CLI SAPI 模块有以下三种不同的方法来获取要运行的 PHP 代码:
1.让 PHP 运行指定文件。

php my_script.php 
php -f my_script.php

以上两种方法(使用或不使用 -f 参数)都能够运行给定的 my_script.php 文件。可以选择任何文件来运行,指定的 PHP 脚本并非必须要以 .php 为扩展名,它们可以有任意的文件名和扩展名。
2.在命令行直接运行 PHP 代码。

php -r 'print_r(get_defined_constants());'

在使用这种方法时,请注意外壳变量的替代及引号的使用。

Note:
请仔细阅读以上范例,在运行代码时没有开始和结束的标记符!加上 -r 参数后,这些标记符是不需要的,加上它们会导致语法错误。

3.(这种没用过。。。)通过标准输入(stdin)提供需要运行的 PHP 代码。
以上用法提供了非常强大的功能,使得可以如下范例所示,动态地生成 PHP 代码并通过命令行运行这些代码:

$ some_application | some_filter | php | sort -u >final_output.txt

以上三种运行代码的方法不能同时使用。

CLI参数详解

-a               以交互式shell模式运行
-c <path>|<file> 指定php.ini文件所在的目录
-n               指定不使用php.ini文件
-d foo[=bar]     定义一个INI实体,key为foo,value为'bar'
-e               为调试和分析生成扩展信息
-f <file>        解释和执行文件<file>.
-h               打印帮助
-i               显示PHP的基本信息
-l               进行语法检查 (lint)
-m               显示编译到内核的模块
-r <code>        运行PHP代码<code>,不需要使用标签 <?..?>
-B <begin_code>  在处理输入之前先执行PHP代码<begin_code>
-R <code>        对输入的没一行作为PHP代码<code>运行
-F <file>        Parse and execute <file> for every input line
-E <end_code>    Run PHP <end_code> after processing all input lines
-H               Hide any passed arguments from external tools.
-S <addr>:<port> 运行内建的web服务器.
-t <docroot>     指定用于内建web服务器的文档根目录<docroot>
-s               输出HTML语法高亮的源码
-v               输出PHP的版本号
-w               输出去掉注释和空格的源码
-z <file>        载入Zend扩展文件 <file>.

args...          传递给要运行的脚本的参数. 当第一个参数以`-`开始或者是脚本是从标准输入读取的时候,使用`--`参数

--ini            显示PHP的配置文件名

--rf <name>      显示关于函数 <name> 的信息.
--rc <name>      显示关于类 <name> 的信息.
--re <name>      显示关于扩展 <name> 的信息.
--rz <name>      显示关于Zend扩展 <name> 的信息.
--ri <name>      显示扩展 <name> 的配置信息.

CLI传参

当使用这个命令执行:php script.php arg1 arg2 arg3

以上例程的输出类似于:
array(4) {
  [0]=>  string(10) "script.php"
  [1]=>  string(4) "arg1"
  [2]=>  string(4) "arg2"
  [3]=>  string(4) "arg3" 
}

CLI交互式shell模式运行php

用过 Python 的朋友对Python的交互式shell比较熟悉,在命令行下,如果我们直接输入python命令,则会进入python的交互式shell程序,接下来就可以交互式的执行一些计算任务。

在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)
在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)

在PHP命令行中,同样提供了类似的功能,使用-a参数即可进入交互shell模式。

在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)
在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)

运行内建的Web服务器

从PHP 5.4.0开始,PHP的命令行模式提供了一个内建的web服务器。使用-S开始运行web服务。
在该目录中,执行以下命令可以启动内建web服务器,并且默认以当前目录为工作目录

在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)
在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)
在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)
在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)

以上我们在启动内建服务器的时候,只指定了-S参数让PHP以web服务器的方式运行,这时,PHP会使用当前目录作为工作目录,因此回到当前目录下寻找请求的文件,我们还可以使用-t参数指定其它的目录作为工作目录(文档根目录)。

查找PHP的配置文件

在有的时候,由于服务器上软件安装比较混乱,我们可能安装了多个版本的PHP环境,这时候,如何定位我们的PHP程序使用的是那个配置文件就比较重要了。在PHP命令行参数中,提供了--ini参数,使用该参数,可以列出当前PHP的配置文件信息

ikeepstudying:sync Ken$ php --ini
Configuration File (php.ini) Path: /usr/local/etc/php/5.5
Loaded Configuration File:         /usr/local/etc/php/5.5/php.ini
Scan for additional .ini files in: /usr/local/etc/php/5.5/conf.d
Additional .ini files parsed:      /usr/local/etc/php/5.5/conf.d/ext-igbinary.ini,
/usr/local/etc/php/5.5/conf.d/ext-libevent.ini,
/usr/local/etc/php/5.5/conf.d/ext-memcache.ini,
/usr/local/etc/php/5.5/conf.d/ext-memcached.ini,
/usr/local/etc/php/5.5/conf.d/ext-mongo.ini,
/usr/local/etc/php/5.5/conf.d/ext-mongodb.ini,
/usr/local/etc/php/5.5/conf.d/ext-xdebug.ini

ikeepstudying:sync Ken$

CLI语法检查

有时候,我们只需要检查php脚本是否存在语法错误,而不需要执行它,比如在一些编辑器或者IDE中检查PHP文件是否存在语法错误。
使用-l(–syntax-check)可以只对PHP文件进行语法检查。

ikeepstudying:sync Ken$ php -l index.php
No syntax errors detected in index.php

$ php -l index.php 
PHP Parse error:  syntax error, unexpected 'echo' (T_ECHO) in index.php on line 3
Parse error: syntax error, unexpected 'echo' (T_ECHO) in index.php on line 3
Errors parsing index.php

查看类/函数/扩展信息

通常,我们可以使用php --info命令或者在在web服务器上的php程序中使用函数phpinfo()显示php的信息,然后再查找相关类、扩展或者函数的信息,这样做实在是麻烦了一些。

$ php --info | grep redis
redis
Registered save handlers => files user redis
This program is free software; you can redistribute it and/or modify

我们可以使用下列参数更加方便的查看这些信息

--rf <name>      显示关于函数 <name> 的信息.
--rc <name>      显示关于类 <name> 的信息.
--re <name>      显示关于扩展 <name> 的信息.
--rz <name>      显示关于Zend扩展 <name> 的信息.
--ri <name>      显示扩展 <name> 的配置信息.

 

参考文献

1.PHP命令行下的世界
2.PHP手册

 

命令行选项
选项名称 长名称 说明
-a –interactive

交互式运行 PHP。如果编译 PHP 时加入了 Readline 扩展(Windows 下不可用),那将会得到一个很好的外壳,包括一个自动完成的功能(例如可以在键入变量名的时候,按下 TAB 键,PHP 会自动完成该变量名)以及命令历史记录,可以用上下键来访问。历史记录存在~/.php_history 文件中。

Note:

通过 auto_prepend_fileauto_append_file 包含的文件在此模式下会被解析,但有些限制,例如函数必须在被调用之前定义。

-c –php-ini

用该参数,可以指定一个放置 php.ini 文件的目录,或者直接指定一个自定义的 INI 文件(其文件名可以不是 php.ini),例如:

$ php -c /custom/directory/ my_script.php

$ php -c /custom/directory/custom-file.ini my_script.php

如果不指定此选项,PHP 将在默认位置搜索文件。

-n –no-php-ini

完全忽略 php.ini。此参数在 PHP 4.3.0 以后有效。

-d –define

用该参数可以自行设置任何可以在 php.ini 文件中设置的配置选项的值,其语法为:

-d configuration_directive[=value]

例子(因版面原因而折行显示):

# 取值部分被省略,将会把配置选项设为 "1"
$ php -d max_execution_time
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(1) "1"

# 取值部分为空白,将会把配置选项设为 ""
php -d max_execution_time=
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(0) ""

# 配置选项将被设置成为任何 '=' 字符之后的值
$  php -d max_execution_time=20
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(2) "20"
$  php
        -d max_execution_time=doesntmakesense
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(15) "doesntmakesense"
-e –profile-info

激活扩展信息模式,被用于调试/测试。

-f –file

解析并运行 -f 选项给定的文件名。该参数为可选参数,可以省略,仅指明需要运行的文件名即可。

-h and -? –help and –usage 使用该参数,可以得到完整的命令行参数的列表及这些参数作用的简单描述。
-i –info 该命令行参数会调用 phpinfo() 函数并显示出结果。如果 PHP 没有正常工作,建议执行 php -i命令来查看在信息表格之前或者对应的地方是否有任何错误信息输出。请注意当使用 CGI 摸索时,输出的内容为 HTML 格式,因此输出的信息篇幅较大。
-l –syntax-check

该参数提供了对指定 PHP 代码进行语法检查的方便的方法。如果成功,则向标准输出写入 No syntax errors detected in <filename> 字符串,并且外壳返回值为 0。如果失败,则输出 Errors parsing <filename> 以及内部解析器错误信息到标准输出,同时外壳返回值将别设置为 255

该参数将无法检查致命错误(如未定义函数),如果也希望检测致命错误,请使用 -f 参数。

Note:

该参数不能和 -r 一同使用。

-m –modules

使用该参数,PHP 将打印出内置以及已加载的 PHP 及 Zend 模块:

$ php -m
[PHP Modules]
xml
tokenizer
standard
session
posix
pcre
overload
mysql
mbstring
ctype

[Zend Modules]
-r –run

使用该参数可以在命令行内运行单行 PHP 代码。无需加上 PHP 的起始和结束标识符(<?php?>),否则将会导致语法解析错误。

Note:

使用这种形式的 PHP 时,应注意避免和外壳环境进行的命令行参数替换相冲突。

显示语法解析错误的范例

$ php -r "$foo = get_defined_constants();"
Command line code(1) : Parse error - parse error, unexpected '='

这里的问题在于即使使用了双引号 ,sh/bash 仍然实行了参数替换。由于 $foo 没有被定义,被替换后它所在的位置变成了空字符,因此在运行时,实际被 PHP 读取的代码为:

$ php -r " = get_defined_constants();"

正确的方法是使用单引号 。在用单引号引用的字符串中,变量不会被 sh/bash 还原成其原值。

$ php -r '$foo = get_defined_constants(); var_dump($foo);'
array(370) {
  ["E_ERROR"]=>
  int(1)
  ["E_WARNING"]=>
  int(2)
  ["E_PARSE"]=>
  int(4)
  ["E_NOTICE"]=>
  int(8)
  ["E_CORE_ERROR"]=>
  [...]

如果使用的外壳不是 sh/bash,可能会碰到更多问题。请将碰到的 Bug 向 » http://bugs.php.net/ 报告。注意,当试图将 shell 变量用到代码中或者使用反斜线时仍然很容易碰到问题。

Note:

-rCLI SAPI 中有效,在 CGI SAPI 中无效。

Note:

此选项只用于非常基本的用途。因此一些配置指令(例如 auto_prepend_fileauto_append_file)在此模式下被忽略。

-B –process-begin

在处理 stdin 之前先执行 PHP 代码。PHP 5 新加。

-R –process-code

对每个输入行都执行 PHP 代码。PHP 5 新加。

此模式下有两个特殊变量:$argn$argi$argn 包含 PHP 当前处理的行内容,而$argi 则包含该行号。

-F –process-file

对每个输入行都执行 PHP 文件。PHP 5 新加。

-E –process-end

在处理完输入后执行的 PHP 代码。PHP 5 新加。

使用 -B-R-E 选项来计算一个项目总行数的例子。

$ find my_proj | php -B '$l=0;' -R '$l += count(@file($argn));' -E 'echo "Total Lines: $l\n";'
Total Lines: 37328
-s –syntax-highlight and –syntax-highlight

显示有语法高亮色彩的源代码。

该参数使用内建机制来解析文件并为其生成一个 HTML 高亮版本并将结果写到标准输出。请注意该过程所做的只是生成了一个 <code> […] </code>HTML 标记的块,并不包含任何的 HTML 头。

Note:

该选项不能和 -r 参数同时使用。

-v –version

将 PHP,PHP SAPI 和 Zend 的版本信息写入标准输出。例如:

$ php -v
PHP 4.3.0 (cli), Copyright (c) 1997-2002 The PHP Group
Zend Engine v1.3.0, Copyright (c) 1998-2002 Zend Technologies
-w –strip

显示除去了注释和多余空白的源代码。

Note:

该选项不能和 -r 参数同时使用。

-z –zend-extension

加载 Zend 扩展库。如果仅给定一个文件名,PHP 将试图从当前系统扩展库的默认路径(在 Linux 系统下,该路径通常由 /etc/ld.so.conf 指定)加载该扩展库。如果用一个绝对路径指定文件名,则不会使用系统的扩展库默认路径。如果用相对路径指定的文件名,则 PHP 仅试图在当前目录的相对目录加载扩展库。

PHP 的命令行模式能使得 PHP 脚本能完全独立于 web 服务器单独运行。如果使用 Unix 系统,需要在 PHP 脚本的最前面加上一行特殊的代码,使得它能够被执行,这样系统就能知道用哪个程序去运行该脚本。在 Windows 平台下可以将 php.exe.php 文件的双击属性相关联,也可以编写一个批处理文件来用 PHP 执行脚本。为 Unix 系统增加的第一行代码不会影响该脚本在 Windows 下的运行,因此也可以用该方法编写跨平台的脚本程序。以下是一个简单的 PHP 命令行程序的范例。

Example #1 试图以命令行方式运行的 PHP 脚本(script.php)

#!/usr/bin/php
<?php

if ($argc != 2 || in_array($argv[1], array('--help', '-help', '-h', '-?'))) {
?>

This is a command line PHP script with one option.

  Usage:
  <?php echo $argv[0]; ?> <option>

  <option> can be some word you would like
  to print out. With the --help, -help, -h,
  or -? options, you can get this help.

<?php
} else {
    echo $argv[1];
}
?>

第一个 PHP shell 脚本

很好 —— 从这里开始事情会变得非常有趣。运用到目前为止学到的简单知识,您可以创建简单而有用的 shell 脚本。在文本编辑器中键入以下代码。

清单 2. randomize-lines
#!/usr/bin/php -q
<?php
        $lines = split("\n", file_get_contents("php://stdin", "r"));
        shuffle($lines);
        foreach ($lines as $line) {
                if ($line !== "") {
                        echo "$line\n";
                }
        }
?>

现在,只需一些快速检查即可运行这个脚本:

  1. 确保 hashbang(第一行,以 #! 开头)被设为先前描述的 PHP 可执行文件的位置
  2. 保存文件
  3. 使用 chmod 添加可执行权限
  4. 运行程序

注:randomize-lines 将完全执行所期望的操作:它打乱键入的输入内容行并将它们以不同的顺序返回回来。这项功能可以颇具价值地填补 shell 脚本库中的空白。

作为此脚本的应用程序示例,您可以使用它为音乐或视频播放器动态生成随机播放列表。例如,要打乱 XMMS 播放列表,请尝试:

./randomize-lines < .xmms/xmms.m3u > temp
mv temp .xmms/xmms.m3u

现在,再升一级。

命令行参数

实际命令行程序使用参数。同样,就像 C 语言和其他类似语言一样,您可以为此目的而使用 argvargc。特别是,argv 是程序的参数数组,第一个参数是程序本身。使用这个函数,构建根据给定参数从文件或用户输入读取数据的程序就不难了。例如,请查看以下代码。

清单 3. randomize-lines-w-args
#!/usr/bin/php -q
<?php
        array_shift($argv);
        if (count($argv) == 0) {
                $argv[0] = "php://stdin";
        }
        foreach ($argv as $file) {
                $lines = split("\n", file_get_contents($file, "r"));
                shuffle($lines);
                foreach ($lines as $line) {
                        if ($line !== "") {
                                echo "$line\n";
                        }
                }
        }
?>

现在您拥有这样一个程序:完全运行的 CLI PHP 程序,它可以接受用户输入,也可以接受文件列表并随机排列每个文件的相关内容。

参考:PHP 命令行?是的,您可以!

本文:在命令行下执行PHP or PHP 执行 shell 指令 (terminal, dos, powershell, shell)

发表评论