PHP 매뉴얼
이전 |  | 다음

# 23. 장. 커맨드 라인에서 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`를 설정할수 있다.

> 참고: `--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`가 된다.

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

> 참고: PHP 4.3.2에서 유닉스 `man`ual 페이지가 추가되었다. 셀 환경에서 `man php`를 쳐넣음으로써 이 페이지를 볼수 있을것이다.

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

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

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

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

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

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

- 셀 환경에 맞지 않는 것들 때문에 `CLI SAPI`에 의해 오버로드되는 `php.ini` 지시자(directive)가 몇가지 존재한다.

  표 23-1. `php.ini` 지시자(directive) 오버로드

  지시자(directive) | `CLI SAPI` 기본값 | 주석
  --- | --- | ---
  html_errors | `FALSE` | 셀에서 에러메시지를 읽을때 의미없는 `HTML`태그로 뒤범벅이 되면 에러메시지를 읽기가 매우 어려울수 있다. 따라서 이 지시자(directive)의 기본값은 `FALSE`다.
  implicit_flush | `TRUE` | print(), echo() 와 비슷한 함수들의 출력은 모두 즉시 출력으로 쓰기 되고 버퍼에 캐시되지 않는다. 표준 출력을 지연시키거나 조작하고 싶다면 output buffering을 사용할수도 있다.
  max_execution_time | 0 (unlimited) | 셀 환경에서 `PHP`를 무한 사용할 가능성때문에, maximum execution time은 unlimited로 설정된다. 웹 응용프로그램은 대부분 매우 빨리 실행이 끝나는 반면에 셀 응용프로그램은 더 많은 시간이 필요한 경우가 많다.
  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']`

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

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

  표 23-2. CLI 전용 상수

  상수 | 설명
  --- | ---

  `STDIN`

  `stdin`에 이미 열려진 스트림. 이 상수는 다음처럼 여는것을 간단하게 해준다.

  `$stdin = fopen('php://stdin', 'r');`

  `STDOUT`

  `stdout`에 이미 열려진 스트림. 이 상수는 다음처럼 여는것을 간단하게 해준다.

  `$stdout = fopen('php://stdout', 'w');`

  `STDERR`

  `stderr`에 이미 열려진 스트림. 이 상수는 다음처럼 여는것을 간단하게 해준다.

  `$stderr = fopen('php://stderr', 'w');`

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

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

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

- `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`에서 셀 툴을 제작할때 좀더 많은 유연성을 허용한다.

  > 참고: `CGI SAPI` 는 커맨드 라인에서 실행할때 `-C` 스위치를 사용하여 `CLI SAPI`의 동작을 지원한다.

`PHP` 바이너리에 의해 제공되는 커맨드 라인 옵션의 리스트는 `PHP`를 `-h`스위치와 함게 실행하므로써 어느때든 질의를 할수 있다.

    Usage: php [options] [-f] <file> [args...]
           php [options] -r <code> [args...]
           php [options] [-- args...]
      -s               Display colour syntax highlighted source.
      -w               Display source with stripped comments and whitespace.
      -f <file>        Parse <file>.
      -v               Version number
      -c <path>|<file> Look for php.ini file in this directory
      -a               Run interactively
      -d foo[=bar]     Define INI entry foo with value 'bar'
      -e               Generate extended information for debugger/profiler
      -z <file>        Load Zend extension <file>.
      -l               Syntax check only (lint)
      -m               Show compiled in modules
      -i               PHP information
      -r <code>        Run PHP <code> without using script tags <?..?>
      -h               This help

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

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

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. 표준 입력(`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`) 스크립트는 보통의 셀이나 펄 스크립트처럼 실행될수 있다:

`#!/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"
    }

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

표 23-3. 커맨드 라인 옵션

옵션 | 설명
--- | ---

-s

색상으로 문법 강조된 소스를 보임.

이 옵션은 파일을 해석하여 `HTML` 강조된 버전을 만드는 내부적 메카니즘을 사용하여 표준출력에 그것을 쓰도록 한다. 주의할점은 이 옵션이 하는 일은 `<code> [...] </code>`블록의 `HTML` 태그를 생성하고, `HTML` 헤더는 생성하지 않는다는 것이다.

> 참고: 이 옵션은 `-r` 옵션과 함께 사용할수 없다.

-w

주석과 공백을 제거한 소스를 보임.

> 참고: 이 옵션은 `-r` 옵션과 함께 사용할수 없다.

-f | `-f` 옵션으로 주어진 파일명을 해석하고 실행함. 이 스위치는 선택적이고 생략가능하다. 파일명만 제공함으로써 실행이 가능하다.

-v

PHP, PHP SAPI, Zend 버전을 표준 출력에 출력함, e.g.

    $ 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

-c

이 옵션으로 `php.ini` 가 위치한 디렉토리를 찾거나 , 사용자 정의의 `INI` 파일 디렉토리(`php.ini`라고 이름붙일 필요가 없다)를 설정할수 있슴. e.g.

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

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

-a | PHP를 대화식으로 실행함.

-d

이 옵션은 `php.ini`에서 허용된 설정 지시자(directive)에 대해서 사용자정의 값을 설정하도록 해줌. 문법은 다음과 같다:

    -d configuration_directive[=value]

Examples (lines are wrapped for layout reasons):

    # 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"

-e | 디버거/분석표를 위한 확장 정보를 생성함.
-z | 젠드 확장을 로드함. 파일명만 주어지면, PHP는 시스템의 현재 기본 라이브러리 경로에서 이 확장을 로드하려고 함(리눅스 시스템에서는 보통 `/etc/ld.so.conf`로 설정되어 있슴) 절대 결로 정보를 갖는 파일명을 전달하면 시스템 라이브러리 검색 경로를 사용하지 않을것이다. 디렉토리 정보를 갖는 상대경로의 파일명은 `PHP`에게 현재 디렉토리에서 상대경로의 확장만 로드하도록 한다.

-l

이 옵션은 주어진 `PHP`코드의 문법 검사만 수행하게 하는 편리한 방법을 제공함. 성공하면, `No syntax errors detected in <filename>`라는 메시지가 표준 출력으로 쓰여지고 셀의 리턴 코드는 `0`이다. 실패하면, 내부적인 해석기 에러와 함께 `Errors parsing <filename>`라는 메시지가 표준 출력으로 쓰여지고 셀의 리턴 코드는 `255`가 된다.

이 옵션은 치명적인 에러를 발견할수 없을것이다 (undefined functions 같은). `-f` 옵션을 사용하면 치명적인 에러도 함께 찾을수 있을것이다.

> 참고: 이 옵션은 `-r` 옵션과 함께 사용할수 없다.

-m

이 옵션을 사용하여, PHP는 내장(로드된)된 PHP 모듈과 Zend 모듈을 출력한다.

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

    [Zend Modules]

-i | 이 커맨드 라인 옵션은 phpinfo()를 호출하고, 결과값을 출력한다. `PHP`가 정확하게 동작하지 않으면, `php -i`를 사용하여 정보 테이블이나 그 테이블 이전에 어떤 에러 메시지가 출력되는지 보도록 지도될수 있다. 출력은 `HTML`내에 존재하고 따라서 꽤 많다는 것에 주의한다.

-r

이 옵션은 커맨드 라인에서 직접 `PHP`를 수행하도록 해줌. `PHP`의 시작과 끝 태그 (`<?php` 과 `?>`)는 필요하지 않다. 만약 존재한다면 해석 에러가 발생할것이다.

> 참고: 이런 형태의 `PHP`를 사용할때 셀에 의해 수행되는 커맨드라인의 변수 치환과 충돌하지 않도록 주의가 필요하다.

> Example showing a parser error

>     $ 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가 아닌 다른 셀을 사용 중이라면, 좀더 많은 다른 경험을 했을수 있다. 편하게 버그 보고를 열거나 phpdoc@lists.php.net에 메일을 보내도록 한다. 아직도 코드내로 셀변수를 취하려고 하거나 회피를 위한 역슬래쉬를 사용해서 어려움을 격기 쉽다. 분명히 경고했다.

> 참고: `-r`는 CLI SAPI에서만 사용가능하다. CGI SAPI 에서는 사용할수 없다.

-h | 이 옵션으로 커맨드 라인의 실질적인 옵션 리스트에 관한 정보와 그들이 수행하는 작업에 대한 한줄의 설명을 볼수 있다.

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

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

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

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

예 23-2. 커맨드 라인의 PHP 스크립트를 수행하기 위한 배치 파일(script.bat)

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

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

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

이전 | 처음으로 | 다음
안전 모드에 의해 제한되는/비활성화되는 함수들 | 위로 | 함수 레퍼런스