How to get parameters in php cli mode

There are two ways for php to receive parameters in cli mode

1. Use the argv array
2. Use the getopt method

1. Use the argv array

For example: you need to execute a php and pass three parameters (type=news, is_hot=1, limit=5)

Create test.php

<?phpprint_r($argv);?>

Execute on the command line

php test.php news 1 5

Output:

Array(
    [0] => test.php
    [1] => news
    [2] => 1
    [3] => 5)

You can see that argv[0] is the name of the currently executed php file, and argv[1]~argv[3] is the value of the passed parameter
argv[1 ] is equal to the value of type
argv[2] is equal to the value of is_hot
argv[3] is equal to the value of limit
In this way, the passed parameters can be obtained according to the argv array for subsequent processing operations.

Disadvantages:
Using the argv array, the passed parameters can be obtained in order. But after obtaining it, a corresponding processing needs to be done. In the above example, argv[1] needs to correspond to the type parameter, argv[2] corresponds to the is_hot parameter, and argv[3] corresponds to the limit parameter. And if the parameters are written in the wrong order during the transfer process, it will cause a program error.

For example:

<?php$param = array();$param[&#39;type&#39;] = $argv[1];$param[&#39;is_hot&#39;] = $argv[2];$param[&#39;limit&#39;] = $argv[3];
print_r($param);?>

Execute

php test.php news 1 5

Output:

Array(
    [type] => news
    [is_hot] => 1
    [limit] => 5)

If the order of delivery is different, the parameter values ​​obtained will be different, resulting in subsequent Program error

Execution

php test.php 1 5 news

Output:

Array(
    [type] => 1
    [is_hot] => 5
    [limit] => news
)

So when using the argv array to pass parameters, you need to pay attention to the order of parameter passing.

2. Use the getopt method

getopt Get options from the command line parameter list

array getopt ( string $options [, array $longopts ] )

Parameters:
options
Each character in this string will be treated as an option character, and options matching the incoming script begin with a single hyphen (-). For example, an option string "x" identifies an option -x. Only a-z, A-Z and 0-9 are allowed.

longopts
Option array. Each element in this array will be treated as an options string, matching the options passed to the script with two hyphens (–). For example, the long option element "opt" identifies an option -opt.

options may contain the following elements:
A single character (no value is accepted)
Character followed by a colon (this option requires a value)
Followed by two characters A colon character (the value of this option is optional)
The value of the option is the first parameter after the string. It doesn't mind if there are spaces before the value.

The formats of options and longopts are almost the same, the only difference is that longopts needs to be an array of options (each element is an option), while options needs a string (each character is an option) .
The separator of the passed value can use spaces or =.
Optional values ​​do not accept spaces as delimiters, only = can be used as delimiters.

Return value
This function will return the option/parameter pair, and return FALSE on failure.
Parsing of options will terminate at the first non-option found, anything after that will be discarded.

1. Use options instance

a,b,c are required values
d is optional value
e is not accepted value

<?php$param = getopt(&#39;a:b:c:d::e&#39;);
print_r($param);?>

Execute

php test.php -a 1 -b 2 -c 3 -d=4 -e 5

Output:

Array(
    [a] => 1
    [b] => 2
    [c] => 3
    [d] => 4
    [e] => 
)

2. Use longopts instance

type,is_hot is the required value
limit is the optional value
expire is the unaccepted value

<?php$longopt = array(    &#39;type:&#39;,    &#39;is_hot:&#39;,    &#39;limit::&#39;,    &#39;expire&#39;);$param = getopt(&#39;&#39;, $longopt);
print_r($param);?>

Execution

php test.php --type news --is_hot 1 --limit=10 --expire=100

Output:

Array(
    [type] => news
    [is_hot] => 1
    [limit] => 10
    [expire] => 
)

3. Find the first non-option and ignore subsequent instances

<?php$longopt = array(    &#39;type:&#39;,    &#39;is_hot:&#39;,    &#39;limit::&#39;,    &#39;expire&#39;);$param = getopt(&#39;&#39;, $longopt);
print_r($param);?>

Execution

php test.php --type news --is_hots 1 --limit=10 --expire=100

Output:

Array
(
    [type] => news
)

Because is_hots is not an option value (is_hot is defined), all parameters from here on are discarded.
Summary:
Use the argv array to pass parameters, the method is simple and easy to implement. The order of the parameters cannot be wrong, and corresponding processing needs to be done after the parameters are obtained.
Use the getopt method, you can use parameter names, and the order of parameters can be arbitrary, which is relatively standardized. (Recommended)

This article introduces the method of obtaining parameters in php cli mode. For more related content, please pay attention to the php Chinese website.

Related recommendations:

How to recursively obtain the value of a specified key in an array through PHP code

Reading a 1G file size through PHP

Explain the PHP class initialization function code

The above is the detailed content of How to get parameters in php cli mode. For more information, please follow other related articles on the PHP Chinese website!