Глава 24. Использование PHP из командной строки

Начиная с версии 4.3, РНР поддерживает новый SAPI-тип (Server Application Programming Interface) под названием CLI, что означает Command Line Interface. Как следует из названия, главной задачей этого SAPI-типа является разработка приложений оболочки/shell (или рабочего стола) с помощью РНР. Имеются весьма небольшие отличия CLI SAPI от других SAPI, которые будут далее рассмотрены в этой главе.

CLI SAPI был выпущен в первый раз с PHP 4.2.0, но тогда это был эксперимент, и нужно было явно включать его командой --enable-cli при запуске ./configure. Начиная с PHP 4.3.0, CLI SAPI больше не является экспериментальным и всегда встроен и устанавливается как двоичный исполняемый файл php (называется php.exe в Windows).

Существенные отличия CLI SAPI от других SAPI:

• В отличие от CGI SAPI, никакие шапки/headers не записываются в вывод.

  Хотя в CGI SAPI имеется способ подавления HTTP-шапок, эквивалентного переключателя для их включения в CLI SAPI нет.

• Имеются определённые директивы php.ini, которые переопределены в CLI SAPI, поскольку они не имеют смысла в среде окружения оболочки:

Таблица 24-1. Переопределение php.ini-директив

Примечание: эти директивы не могут быть инициализированы другим значением из файла конфигурации php.ini или специального файла (если специфицирован). Это является некоторым ограничением, поскольку эти значения по умолчанию применяются после разбора всех файлов конфигурации. Однако их значение может быть изменено на этапе прогона программы (что не имеет смысла для всех других директив, например, для register_argc_argv).

• Легче работать в среде оболочки, когда определены следующие константы:

  Таблица 24-2. Специфические CLI-константы

  Константа	Описание
  STDIN	Уже открытый поток в stdin. Она хранит открывшего её $stdin = fopen('php://stdin', 'r');
  STDOUT	Уже открытый поток в stdout. Она хранит открывшего её $stdout = fopen('php://stdout', 'w');
  STDERR	Уже открытый поток в stdout. Она хранит открывшего её $stderr = fopen('php://stderr', 'w');

  Имея всё это, вы не должны, например, самостоятельно открывать поток для stderr, а просто используете константу вместо ресурса потока:

  php -r 'fwrite(STDERR, "stderr\n");'

  Вам не нужно явно закрывать эти потоки, это делается РНР автоматически.

• CLI SAPI не изменяет текущую директорию на директорию исполняемого скрипта!

  Пример, показывающий отличие CGI SAPI:

  <?php /* Простое тестирующее приложение */ echo getcwd(), "\n"; ?>

  Когда используется CGI-версия, на выходе будет:

  $ pwd /tmp $ php-cgi -f another_directory/test.php /tmp/another_directory

  Это ясно показывает, что PHP изменяет свою текущую директорию на директорию исполняемого скрипта.

  Использование CLI SAPI даёт:

  $ pwd /tmp $ php -f another_directory/test.php /tmp

  Это даёт большую гибкость при написании утилит командной строки на PHP.

  Примечание: CGI SAPI поддерживает поведение CLI SAPI с помощью ключа -C при запуске из командной строки.

Список опций командной строки исполняемого файла PHP может быть получен в любое время путём запуска PHP с ключом -h:

Usage/Использование: php [options] [-f] <file> [args...]
       php [options] -r <code> [args...]
       php [options] [-- args...]
  -s               Отображает исходный текст с разными цветами.
  -w               Отображает исходный текст без комментариев и пробелов.
  -f <file>        Разбирает <file>.
  -v               Номер версии.
  -c <path>|<file> Ищет файл php.ini в данной директории.
  -a               Запустить интерактивно.
  -d foo[=bar]     Определить INI-вхождение foo со значением 'bar'.
  -e               Генерировать расширенную информацию для отладчика/profiler'а.
  -z <file>        Загрузить <file> Zend-расширения.
  -l               Только проверить синтаксис (lint).
  -m               Показать скомпилированные модули.
  -i               PHP-информация.
  -r <code>        Запустить PHP <code> без использования тэгов скрипта <?..?>
  -h               Данный help.

  args...          Аргументы, передаваемые скрипту. Используйте -- args когда
                   первый аргумент начинается с - или скрипт читается из stdin

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());'

   Особого внимания требует замена переменных оболочки и использование кавычек.

   Примечание: просмотрите пример внимательно, нет начальных и конечных тэгов! Переключателю -r они просто не нужны. Использование их в данном случае приведёт к ошибке разборщика.

3. Предоставить PHP-код для выполнения через стандартный ввод (stdin).

   Это позволяет динамически создавать PHP-код и передавать его экзешнику, как показано в данном (надуманном) примере:

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

Вы не можете комбинировать эти три способа при выполнении кода.

Как и в любом приложении оболочки, не только сам PHP, но и ваши скрипты PHP также принимают аргументы. Количество передаваемых в скрипт аргументов в РНР не ограничивается (оболочка имеет ограничение на количество передаваемых символов).
Аргументы, передаваемые в ваш скрипт, доступны через глобальный массив $argv. Нулевой индекс всегда содержит имя скрипта (которое является символом - в случае, когда PHP-код приходит со стандартного ввода или с использованием ключа командной строки -r).
Вторая регистрируемая глобальная переменная это $argc, которая содержит количество элементов в массиве $argv (а не количество аргументов, передаваемых в скрипт).

Если аргументы, которые вы хотите передать в скрипт, не начинаются с символа дефиса (-), ничего специально наблюдать не надо. Передача в скрипт аргумента, начинающегося с - , создаст проблемы, поскольку PHP думает, что должен сам их обработать. Чтобы предотвратить это, используйте в качестве сепаратора аргументов списка --. После того как аргумент будет разобран PHP, каждый последующий аргумент передаётся в ваш скрипт без изменений/не разобранным.

# Это не выполнит данный код, но продемонстрирует использование PHP
$ php -r 'var_dump($argv);' -h
Usage: php [options] [-f] <file> [args...]
[...]

# Аргумент '-h' будет передан в ваш скрипт, что предупредит показ PHP его использования
$ php -r 'var_dump($argv);' -- -h
array(2) {
  [0]=>
  string(1) "-"
  [1]=>
  string(2) "-h"
}

Однако, вот другой способ использования PHP для скриптинга оболочки. Вы можете написать скрипт, первая строка которого начинается с #!/usr/bin/php, а затем идёт нормальный PHP-код, содержащийся между начальным и конечным тэгами PHP, и соответствующим образом устанавливаются атрибуты выполнения файла. Таким способом он может быть исполнен как нормальный скрипт оболочки или perl:

#!/usr/bin/php
<?php
    var_dump($argv);
?>

Приняв, что файл называется test и находится в текущей директории, мы можем выполнить:

$ chmod 755 test
$ ./test -h -- foo
array(4) {
  [0]=>
  string(6) "./test"
  [1]=>
  string(2) "-h"
  [2]=>
  string(2) "--"
  [3]=>
  string(3) "foo"
}

Как вы видите, ничего особо не нужно делать при передаче параметров в скрипт, который начинается с -.

Таблица 24-3. Опции командной строки

Исполняемый файл PHP может быть использован для запуска PHP-скриптов абсолютно независимо от web-сервера.
Если вы работаете под Unix, вы должны добавлять специальную первую строчку в ваши PHP-скрипты и делать их исполняемыми, чтобы система знала, какая программа должна выполнять эти скрипты.
Под Windows вы можете ассоциировать php.exe с опцией двойного щелчка по файлам .php либо сделать batch-файл (.bat) для запуска скрипта через PHP. Строка, добавленная в начало скрипта для работы под Unix, не помешает под Windows, поэтому вы можете писать таким образом межплатформенные программы. Ниже дан пример простой РНР-программы для выполнения из командной строки.

#!/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. Мы работаем с CLI-версией, поэтому не выполняется вывод HTTP-шапок/header. Имеются две переменные, которые вы можете использовать при написании РНР-приложений для командной строки: $argc и $argv. Первая - это количество аргументов плюс 1 (имя запущенного скрипта). Вторая - это массив аргументов, начиная с имени скрипта с индексом ноль ($argv[0]).

Мы проверяем, имеется ли менее или более одного аргумента. Также, если аргумент был --help, -help, -h или -?, мы печатаем help-сообщение, выводя имя скрипта динамически. Если мы получили какой-либо другой аргумент, мы выводим его (echo).

Если вы хотите выполнить вышеприведённый скрипт под Unix, вам необходимо сделать его executable и просто вызвать как script.php echothis или script.php -h. Под Windows вы можете создать batch-файл для выполнения этой задачи:

@c:\php\php.exe script.php %1 %2 %3 %4

Приняв, что вы назвали программу script.php и что ваш php.exe находится в c:\php\php.exe, этот batch-файл запустит её с добавленными вами опциями: script.bat echothis или script.bat -h.

См. также в документации по расширению Readline о функциях, которые можно использовать для усовершенствования вашего РНР-приложения для командной строки.