명령줄에서 PHP 사용하기

버전 4.3.0부터 PHP는 Command Line Interface를 의미하는 CLI라는 이름의 새로운 SAPI(Server Application Programming Interface) 형식을 지원한다. 이 SAPI는 이름에서 내포하듯이, 핵심 용도는 셀(또는 데스크탑) 응용프로그램을 PHP로 개발하는것에 맞춰져있다. 이 장에서 설명하는 CLI SAPI와 SAPI사이에는 많은 차이가 있다. CLI와 CGI는 많은 부분에 있어서 같은 동작을 하지만, 서로 다른 SAPI들이라는 것이다.

CLI SAPI는 PHP 4.2.0에서 처음으로 릴리즈되었다. 그러나 아직 실험적이었고 ./configure를 실행할때 --enable-cli을 명시해 주어야 했다. PHP 4.3.0부터 CLI SAPI는 더이상 실험적이지 않고 기본값으로 --enable-cli가 활성화되어있다. 그리고 --disable-cli로 비활성화시킬수 있다.

PHP 4.3.0부터, CLI/CGI 바이너리의 이름과 위치, 존재여부는 PHP가 시스템에 어떻게 설치되느냐에 따라 달라질 것이다. 기본값으로 make를 수행할때, CGI와 CLI 모두 빌드되고 각각 sapi/cgi/php와 sapi/cli/php에 위치하게 된다. 둘 다 php라는 이름이 붙는다는것에 주의해야 할것이다. configure 줄에 따라 make install 시에 무슨일이 일어날까. configure 시에 모듈로 SAPI를 선택했다면, 즉 apxs를 사용하거나, 또는 --disable-cgi 옵션을 사용하면 CLI는 make install시에 {PREFIX}/bin/php에 복사된다. 예를 들면, --with-apxs가 configure 줄에 포함되면 make install시에 CLI는 {PREFIX}/bin/php에 복사된다. CGI 바이너리 설치를 오버라이드하고 싶다면 make install 이후에 make install-cli를 사용한다. 차선책으로 configure 줄에 --disable-cgi를 설정할수 있다.

Note: --enable-cli와 --enable-cgi는 모두 기본값으로 켜져 있기 때문에, 단순히 configure줄에 --enable-cli를 넣는것이 make install시에 {PREFIX}/bin/php에 CLI를 복사할것이라는 것을 의미하지 않는다.

PHP 4.2.0 과 PHP 4.2.3 사이의 윈도우 패키지는 CLI를 php-cli.exe로 제공한다. CGI인 php.exe와 같은 폴더에 존재한다. PHP 4.3.0부터 윈도우 패키지 배포판은 CLI를 별개의 폴더 cli에 php.exe를 놓으므로, cli/php.exe가 됩니다. PHP 5부터, CLI는 메인 폴더에 php.exe로 배포됩니다. CGI 버전은 php-cgi.exe로 배포됩니다.

PHP 5부터, 새로운 php-win.exe 파일이 배포됩니다. 이는 CLI 버전과 동일하지만, php-win은 아무것도 출력하지 않으므로, 콘솔을 제공하지 않습니다. (화면에 "도스 박스"가 나타나지 않습니다) 이 동작은 php-gtk와 비슷합니다. --enable-cli-win32로 configure해야 합니다.

Note: 현재 사용중인 SAPI는 무엇인가?
셀에서, php -v를 쳐넣으면 php가 CGI인지 CLI인지 알수 있을것이다. php_sapi_name()과 상수PHP_SAPI도 참고.

Note: PHP 4.3.2에서 유닉스 manual 페이지가 추가되었다. 셀 환경에서 man php를 침으로써 이 페이지를 볼수 있을것이다.

다른 SAPI와 비교한 CLI SAPI의 현저한 차이점:

• CGI SAPI와는 달리, 출력에 헤더를 쓰지 않는다.

  CGI SAPI가 HTTP 헤더를 제거하는 방법을 제공하지만, CLI SAPI에서는 헤더를 활성화시킬수 있는 스위치가 존재하지 않는다.

  CLI는 기본적으로 정숙 모드로 시작된다. 그러나 구버전의 CGI 스크립트와의 호환성을 위해 -q 스위치를 유지하고 있다.

  작업 디렉토리가 스크립트의 디렉토리로 변경되지 않는다 (-C와 --no-chdir 스위치는 호환성을 유지됩니다)

  일반 텍스트 에러 메시지 (HTML 포맷이 아님)

• 셀 환경에 맞지 않는 것들 때문에 CLI SAPI에 의해 오버로드되는 php.ini 지시어가 몇가지 존재한다.

  php.ini 지시어 오버로드

  지시어	CLI SAPI 기본값	주석
  html_errors	FALSE	셀에서 에러메시지를 읽을때 의미없는 HTML태그로 뒤범벅이 되면 에러메시지를 읽기가 매우 어려울수 있다. 따라서 이 지시어의 기본값은 FALSE다.
  implicit_flush	TRUE	print(), echo() 와 비슷한 함수들의 출력은 모두 즉시 출력으로 쓰기 되고 버퍼에 캐시되지 않는다. 표준 출력을 지연시키거나 조작하고 싶다면 output buffering을 사용할수도 있다.
  max_execution_time	0 (무제한)	셀 환경에서 PHP를 무한하게 사용할 가능성때문에, 최대 실행 시간은 무제한으로 설정된다. 웹 응용프로그램은 대부분 매우 빨리 실행이 끝나는 반면에 셀 응용프로그램은 더 많은 시간이 필요한 경우가 많다.
  register_argc_argv	TRUE	이 설정은 TRUE이기 때문에 CLI SAPI에서는 항상 argc (응용프로그램에 전달되는 인수의 수) 와 argv (응용프로그램에 전단되는 인수의 배열)을 사용할수 있을것이다. PHP 4.3.0부터, CLI SAPI는 PHP 변수 $argc와 $argv가 등록되고 적절한 값으로 채워지게 된다. 이 변수의 생성은 CGI와 MODULE 버전과 같이 register_globals가 on되어 있어야 한다. 버전이나 register_globals의 설정에 관계없이, $_SERVER나 $HTTP_SERVER_VARS로 그 값에 접근할수 있다. Example: $_SERVER['argv']

  Note: 이 지시어는 설정 파일 php.ini나 사용자 설정으로부터 온 다른 값으로 초기화될수 없다. 모든 설정 파일이 해석되고 난 후에 기본값이 적용되기 때문에 이 것은 제한이 된다. 하지만, 각 값은 런타임동안에 변경될수 있다. (위 지시어 중 환경과 맞지 않는것 e.g. register_argc_argv).
  

• 셀 환경에서의 작업을 편하게 하기 위해, 다음 상수가 정의되었다:

  CLI 전용 상수

  상수	설명
  STDIN	stdin에 이미 열려진 스트림. 이 상수는 다음처럼 여는것을 간단하게 해준다. <?php $stdin = fopen('php://stdin', 'r'); ?> stdin에서 한 줄을 읽으려면, 다음처럼 할 수 있습니다. <?php $line = trim(fgets(STDIN)); // STDIN에서 한 줄을 읽습니다 fscanf(STDIN, "%d\n", $number); // STDIN에서 수를 읽습니다 ?>
  STDOUT	stdout에 이미 열려진 스트림. 이 상수는 다음처럼 여는것을 간단하게 해준다. <?php $stdout = fopen('php://stdout', 'w'); ?>
  STDERR	stderr에 이미 열려진 스트림. 이 상수는 다음처럼 여는것을 간단하게 해준다. <?php $stderr = fopen('php://stderr', 'w'); ?>

  위에서 설명한대로 예를 들면 stderr에 대한 스트림을 직업 열필요가 없다. 스트림 자원 대신 단순하게 상수를 사용하면 된다.

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

  이 스트림을 명시적으로 닫을 필요가 없다. 스크립트가 끝날때 PHP에 의해 자동적으로 닫히기 때문이다.

  Note: 이 상수들은 PHP 스크립트를 stdin에서 읽을 경우에는 사용할 수 없습니다.
  

• CLI SAPI는 현재 디렉토리를 실행중인 스크립트의 디렉토리로 변경 하지않는다!

  다음예는 CGI SAPI와의 차이점을 보여준다:

  <?php
// Our simple test application named test.php
echo getcwd(), "\n";
?>

  CGI 버전을 사용할때, 출력은:

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

  이 예제코드는 PHP가 현재 디렉토리를 실행스크립트의 디렉토리로 변경하는것을 보여준다.

  CLI SAPI를 사용할때는 다음과 같다:

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

  이것은 PHP에서 셀 툴을 제작할때 좀더 많은 유연성을 허용한다.

  Note: CGI SAPI 는 명령줄에서 실행할때 -C 스위치를 사용하여 CLI SAPI의 동작을 지원한다.
  

PHP 바이너리에 의해 제공되는 명령줄 옵션의 리스트는 PHP를 -h 스위치와 함께 실행하므로써 어느때든 질의를 할수 있다.

Usage: php [options] [-f] <file> [--] [args...]
       php [options] -r <code> [--] [args...]
       php [options] [-B <begin_code>] -R <code> [-E <end_code>] [--] [args...]
       php [options] [-B <begin_code>] -F <file> [-E <end_code>] [--] [args...]
       php [options] -- [args...]
       php [options] -a

  -a               Run interactively
  -c <path>|<file> Look for php.ini file in this directory
  -n               No php.ini file will be used
  -d foo[=bar]     Define INI entry foo with value 'bar'
  -e               Generate extended information for debugger/profiler
  -f <file>        Parse and execute <file>.
  -h               This help
  -i               PHP information
  -l               Syntax check only (lint)
  -m               Show compiled in modules
  -r <code>        Run PHP <code> without using script tags <?..?>
  -B <begin_code>  Run PHP <begin_code> before processing input lines
  -R <code>        Run PHP <code> for every input line
  -F <file>        Parse and execute <file> for every input line
  -B <begin_code>  Run PHP <end_code> after processing all input lines
  -H               Hide any passed arguments from external tools.
  -s               Display colour syntax highlighted source.
  -v               Version number
  -w               Display source with stripped comments and whitespace.
  -z <file>        Load Zend extension <file>.

  args...          Arguments passed to script. Use -- args when first argument 
                   starts with - or script is read from stdin

  --ini            Show configuration file names

  --rf <name>      Show information about function <name>.
  --rc <name>      Show information about class <name>.
  --re <name>      Show information about extension <name>.
  --ri <name>      Show configuration for extension <name>.

CLI SAPI는 실행하고자 하는 PHP 코드를 취하는 3가지의 방법을 사용한다.

1. PHP에게 특정 파일을 실행하도록 지정함.

   php my_script.php
   
   php -f my_script.php
   

   두 방법 (-f 스위치를 사용하거나 안하는것)은 모두 my_script.php을 실행한다. 실행하고자하는 파일을 선택할수 있다 - PHP 스크립트는 .php 확장자 로 끝날필요없이 어떤 이름이나 원하는 확장자를 갖을수 있다.

   Note: 스크립트에 인수를 전달해야 할 때, -f 스위치를 사용할 경우 --을 첫번째 인수로 전달해야 합니다.
   

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
   

코드를 수행하기 위한 세 가지 방법의 어떤것도 조합할수 없다.

모든 셀 응용 프로그램처럼, PHP 바이너리는 많은수의 인수를 허용하고 PHP 스크립트도 인수를 받을수 있다. 스크립트로 전달할수 있는 인수의 갯수는 PHP에 의해 제한받지 않는다. (셀은 전달할수 있는 문자 갯수의 제한을 갖는다; 보통 이 제한을 넘지 않을것이다) 스크립트로 전달할수 있는 인수는 전역 배열 $argv에 존재한다. 제로 인덱스는 항상 스크립트 명을 포함한다 (PHP 코드가 표준 입력이나 명령줄 스위치 -r로부터 온 경우에는 - ). 두번째로 등록된 전역 변수는 $argv배열의 구성요소 수를 갖는 $argc이다 (스크립트로 전달되는 인수의 수가 아니다)

스크립트로 전달하려는 인수가 -문자로 시작되지 않는한, 특별하게 조심할 필요는 없다. -로 시작하는 인수를 스크립트에 전달하면 문제가 발생할 소지가 있다 왜냐하면 PHP는 그 인수를 PHP가 제어해야 한다고 생각하기 때문이다. 이런일이 발생하지 않기 위해서는, -- 구분자의 인수 리스트를 사용한다. 이 구분자가 PHP에 의해 해석된 후에, 그 뒤의 모든 인수가 스크립트로 온전히 전달된다.

# This will not execute the given code but will show the PHP usage
$ php -r 'var_dump($argv);' -h
Usage: php [options] [-f] <file> [args...]
[...]

# This will pass the '-h' argument to your script and prevent PHP from showing it's usage
$ php -r 'var_dump($argv);' -- -h
array(2) {
  [0]=>
  string(1) "-"
  [1]=>
  string(2) "-h"
}

하지만, 셀 스크립트에서 PHP를 사용하는 다른 방법이 있다. 첫번째 줄을 #!/usr/bin/php로 시작하는 스크립트를 작성할수 있다. 이 줄 뒤에는 PHP의 시작과 끝 태그 안에 포함된 일반적인 PHP 코드를 놓을수 있다. 이 파일에 적절하게 실행 속성을 설정하면 (e.g. chmod +x test) 스크립트는 보통의 셀이나 펄 스크립트처럼 실행될수 있다:

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

위와 같은 경우에 -로 시작하는 인수를 스크립트로 전달할때에도 주의할 필요가 없다.

긴 옵션은 PHP 4.3.3부터 사용할 수 있습니다.

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

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

-d configuration_directive[=value]

# Omitting the value part will set the given configuration directive to "1"
$ php -d max_execution_time
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(1) "1"

# Passing an empty value part will set the configuration directive to ""
php -d max_execution_time=
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(0) ""

# The configuration directive will be set to anything passed after the '=' character
$  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"

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

[Zend Modules]

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

$ 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

$ php --ini
Configuration File (php.ini) Path: /usr/dev/php/5.2/lib
Loaded Configuration File:         /usr/dev/php/5.2/lib/php.ini
Scan for additional .ini files in: (none)
Additional .ini files parsed:      (none)

$ php --rf var_dump
Function [ <internal> public function var_dump ] {

  - Parameters [2] {
    Parameter #0 [ <required> $var ]
    Parameter #1 [ <optional> $... ]
  }
}

$ php --rc Directory
Class [ <internal:standard> class Directory ] {

  - Constants [0] {
  }

  - Static properties [0] {
  }

  - Static methods [0] {
  }

  - Properties [0] {
  }

  - Methods [3] {
    Method [ <internal> public method close ] {
    }

    Method [ <internal> public method rewind ] {
    }

    Method [ <internal> public method read ] {
    }
  }
}

$ php --re json
Extension [ <persistent> extension #19 json version 1.2.1 ] {

  - Functions {
    Function [ <internal> function json_encode ] {
    }
    Function [ <internal> function json_decode ] {
    }
  }
}

$ php --ri date

date

date/time support => enabled
"Olson" Timezone Database Version => 2007.5
Timezone Database => internal
Default timezone => Europe/Oslo

Directive => Local Value => Master Value
date.timezone => Europe/Oslo => Europe/Oslo
date.default_latitude => 59.22482 => 59.22482
date.default_longitude => 11.018084 => 11.018084
date.sunset_zenith => 90.583333 => 90.583333
date.sunrise_zenith => 90.583333 => 90.583333

PHP 실행 파일은 웹서버와 절대적으로 독립적인 PHP 스크립트를 실행하기 위해 사용될수 있다. 유닉스 시스템에 있다면, PHP 스크립트의 첫번째 줄에 특별한 것을 추가해야 하고, 실행가능하게 해서, 무슨 프로그램이 스크립트를 수행시킬지 시스템이 알수 있도록 한다. 윈도우 플랫폼에서는 .php파일의 더블 클릭 옵션을 갖는 php.exe와 연관시킬수 있거나, PHP를 통해 그 스크립트를 수행하도록 배치 파일을 만들수 있다. 유닉스에서 실행시키기위해 추가된 첫번째 줄은 윈도우에 아무런 해가 없을것이다. 그래서 이 방법을 사용하여 플랫폼 프로그램을 번갈아 작성할수 있다. 명령줄 PHP 프로그램을 작성하는 단순한 에제 코드를 아래에서 볼수 있다.

위 스크립트에서, 특별한 첫번째 줄을 사용하여 이 파일이 PHP에 의해 실행되어야 한다는 것을 가리킨다. CLI 버전을 사용한다면, HTTP 헤더가 존재하지 않을것이다. PHP 의 커맨드라인 응용프로그램을 작성할때 사용할수 있는 두개의 변수가 존재한다:$argc와 $argv. 첫번째 변수는 인수 갯수에 하나(스크립트명)가 추가된 값이다. 두번째 변수는 인수들를 포함하는 배열인데, 이 배열은 제로 ($argv[0])에 스크립트명을 갖으면 시작된다.

위 프로그램에서는 인수가 하나 이하인가 이상인가를 체크한다. 인수가 --help나, -help, -h, -?이면, help 메시지를 출력하고, 스크립트명을 동적으로 출력한다. 다른 인수를 받게 되면, 그 인수를 출력한다.

유닉스에서 위 스크립트를 수행하려 하면, 그 파일을 실행가능하게 해서 단순히 script.php echothis나 script.php -h를 호출하면 된다. 윈도우에서는, 이 작업을 위해 배치 파일을 만들수 있다.

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

위 프로그램이 script.php이란 이름을 갖고, C:\php\php.exe 안에 CLI php.exe를 갖는다면 이 배치 파일은 추가된 옵션과 함께 실행이 될것이다: script.bat echothis나 script.bat -h.

PHP의 명령줄 응용 프로그램의 기능을 확장하기 위한 좀더 많은 함수를 보기위해 Readline 확장에 대한 문서도 참고한다.