PHP: Hypertext Preprocessor (original) (raw)

-a

--interactive

Run PHP interactively. For more information, see the Interactive shell section.

-b

--bindpath

Bind Path for external FASTCGI Server mode (CGI only).

-C

--no-chdir

Do not chdir to the script's directory (CGI only).

-q

--no-header

Quiet-mode. Suppress HTTP header output (CGI only).

-T

--timing

Measure execution time of script repeated count times (CGI only).

-c

--php-ini

Specifies either a directory in which to look forphp.ini, or a custom INI file (which does not need to be named php.ini), e.g.:

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

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

If this option is not specified, php.ini is searched for in thedefault locations.

-n

--no-php-ini

Ignore php.ini completely.

-d

--define

Set a custom value for any of the configuration directives allowed in php.ini. The syntax is:

-d configuration_directive[=value]

Example #1 Example of using -d to set an INI setting

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

--profile-info

Activate the extended information mode, to be used by a debugger/profiler.

-f

--file

Parse and execute the specified file. The-f is optional and may be omitted - providing just the filename to execute is sufficient.

-h and -?

--help and --usage

Output a list of command line options with one line descriptions of what they do.

-i

--info

Calls phpinfo(), and prints out the results. If PHP is not working correctly, it is advisable to use the commandphp -i and see whether any error messages are printed out before or in place of the information tables. Beware that when using the CGI mode the output is inHTML and therefore very large.

-l

--syntax-check

Syntax check but do not execute the given PHP code. The input from standard input will be processed if no filenames are specified, otherwise each filename will be checked. On success, the textNo syntax errors detected in <filename> is written to standard output. On failure, the text Errors parsing <filename> is written to standard output in addition to the internal parser error. If any failures are found in the specified files (or standard input), the shell return code is set to -1, otherwise the shell return code is set to 0.

This option won't find fatal errors (like undefined functions) that require executing the code.

Note:

Prior to PHP 8.3.0, it was only possible to specify one filename to be checked.

Note:

This option does not work together with the -r option.

-m

--modules

Example #2 Printing built in (and loaded) PHP and Zend modules

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

[Zend Modules]

-r

--run

Allows execution of PHP included directly on the command line. The PHP start and end tags (<?php and?>) are not needed and will cause a parse error if present.

Note:

Care must be taken when using this form of PHP not to collide with command line variable substitution done by the shell.

Example #3 Getting a syntax error when using double quotes

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

Parse error: syntax error, unexpected '=' in Command line code on line 1

The problem here is that sh/bash performs variable substitution even when using double quotes ". Since the variable $foo is unlikely to be defined, it expands to nothing which results in the code passed to PHP for execution actually reading:

$ php -r " = get_defined_constants();"

The correct way would be to use single quotes '. Variables in single-quoted strings are not expanded by sh/bash.

Example #4 Using single quotes to prevent the shell's variable substitution

$ 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"]=> [...]

If using a shell other than sh/bash, further issues might be experienced - if appropriate, a bug report should be opened at» https://github.com/php/php-src/issues. It is still easy to run into trouble when trying to use variables (shell or PHP) in command-line code, or using backslashes for escaping, so take great care when doing so. You have been warned!

Note:

-r is available in the CLI SAPI, but not in the_CGI_ SAPI.

Note:

This option is only intended for very basic code, so some configuration directives (such as auto_prepend_file and auto_append_file) are ignored in this mode.

-B

--process-begin

PHP code to execute before processing stdin.

-R

--process-code

PHP code to execute for every input line.

There are two special variables available in this mode:$argn and argi.argi.argi.argn will contain the line PHP is processing at that moment, while $argi will contain the line number.

-F

--process-file

PHP file to execute for every input line.

-E

--process-end

PHP code to execute after processing the input.

Example #5 Using the -B, -R and-E options to count the number of lines of a project.

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

-S

--server

Starts built-in web server.

-t

--docroot

Specifies document root for built-in web server.

-s

--syntax-highlight and --syntax-highlighting

Display colour syntax highlighted source.

This option uses the internal mechanism to parse the file and writes an HTML highlighted version of it to standard output. Note that all it does is generate a block of<code> [...] </code> HTML tags, no HTML headers.

Note:

This option does not work together with the -r option.

-v

--version

Example #6 Using -v to get the SAPI name and the version of PHP and Zend

$ php -v PHP 5.3.1 (cli) (built: Dec 11 2009 19:55:07) Copyright (c) 1997-2009 The PHP Group Zend Engine v2.3.0, Copyright (c) 1998-2009 Zend Technologies

-w

--strip

Display source with comments and whitespace stripped.

Note:

This option does not work together with the -r option.

-z

--zend-extension

Load Zend extension. If only a filename is given, PHP tries to load this extension from the current default library path on your system (usually /etc/ld.so.conf on Linux systems, for example). Passing a filename with an absolute path will not use the system's library search path. A relative filename including directory information will tell PHP to try loading the extension relative to the current directory.

--ini

Show configuration file names and scanned directories.

Example #7 --ini example

$ 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)

--rf

--rfunction

Show information about the given function or class method (e.g. number and name of the parameters).

This option is only available if PHP was compiled withReflection support.

Example #8 basic --rf usage

$ php --rf var_dump Function [ public function var_dump ] {

• Parameters [2] { Parameter #0 [ $var ] Parameter #1 [ $... ] } }

--rc

--rclass

Show information about the given class (list of constants, properties and methods).

This option is only available if PHP was compiled withReflection support.

Example #9 --rc example

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

• Constants [0] { }

• Static properties [0] { }

• Static methods [0] { }

• Properties [0] { }

• Methods [3] { Method [ public method close ] { }

  Method [ public method rewind ] { }

  Method [ public method read ] { }

} }

--re

--rextension

Show information about the given extension (list of php.ini options, defined functions, constants and classes).

This option is only available if PHP was compiled withReflection support.

Example #10 --re example

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

• Functions { Function [ function json_encode ] { } Function [ function json_decode ] { } } }

--rz

--rzendextension

Show the configuration information for the given Zend extension (the same information that is returned by phpinfo()).

--ri

--rextinfo

Show the configuration information for the given extension (the same information that is returned by phpinfo()). The core configuration information is available using "main" as extension name.

Example #11 --ri example

$ php --ri date

date

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

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