PHP Command Line Arguments Parser: Parse and extract arguments from the command line

Recommend this page to a friend!

Download .zip

Info

Example

View files (61)

Download .zip

Reputation

Support forum (1)

Blog

Links

Last Updated		Ratings				Unique User Downloads		Download Rankings
2022-10-21 (11 months ago)		75%				Total: 122		All time: 9,423 This week: 48

Version		License		PHP version		Categories
`clparser` 1.0.2		GNU Free Document...		5.5		PHP 5, Console, Parsers

Description

Author

Christian Vigh

This class can parse and extract arguments from the command line.

It takes a XML string with the definition of the supported syntax of parameters to be parsed from the command line.

The class parses the command line arguments array and returns the values of the respective parameters.

The values of the parsed command line arguments can be accessed as class variables.

It supports parameters of many types like: strings, filenames, directory names, flags, numeric value (with the ability to specify expressions to be computed at run-time), arrays, lists, sets and bitsets, email addresses, IP addresses, masks, ranges, domain names, keywords, etc..

The class can also show the usage help output message to tell the user what is the expected arguments syntax.

Innovation Award

December 2016
Number 6

There are many solutions to parse and extract the arguments passed to a PHP script from the command line but most do not do much more than extracting the text values for each parameter switch.

This class provides a more advanced solution that can read the definitions of what is expected for each parameters from a XML files, so you can separate the parameter processing code from its definition.

It also supports many types of parameters so it can perform the necessary validation of each parameter with less application code.

The class can also perform calculations of numeric values passed as math expressions that the class can evaluate before returning the value to the application.

Manuel Lemos

Christian Vigh

Performance

Level

Name:	Christian Vigh `<contact>`
Classes:	32 packages by Christian Vigh
Country:	France
Age:	57
All time rank:	138	10 in France
Week rank:	10	1 in France

Level 6

Innovation award

Nominee: 20x

Winner: 3x

Example


#!/usr/bin/php

<?php

/**************************************************************************************************************



    The following example accepts the following arguments and displays their values :

    - A flag named 'boolean_flag', which also has the 'bf' alias

    - An optional string parameter, named 'string_parameter' (or 'sp') with a default value of 

      "this is the default value".

    - An unlimiter number of strings or filenames.



    Since no "name=" attribute is specified on the <command> tag of the parameter definitions, it will be

    set to the name of the current script, without its extension.



    Note also that the usage text contains some PHP code, which displays the current date and time.



    You can invoke the script using the reserved parameters -help, -usage or -topics ; but you can also

    specify the special parameters beginning with "--".



 **************************************************************************************************************/



require_once ( dirname ( __FILE__ ) . '/../examples.inc.php' ) ;



$definitions    =  <<<END

    <command allow-files="true" min-files="0">



        <usage>

            This is an example script which allows an unlimited number of filenames to be specified, 

            a flag named -boolean_flag, and a string parameter named -string_parameter.

            The current date is : <?= date ( 'Y-m-d H:i:s' ) ; ?>.

        </usage>



        <flag name="boolean_flag, bf">

            A boolean flag.

        </flag>



        <double name="double_value, dv">

            A double (float) value.

        </double>



        <string name="string_parameter, sp" default="This is the default value">

            A string parameter.

        </string>

            

    </command>

END;



// Instantiate a command-line parser object

$CL    =  new CLParser ( $definitions ) ;



// Get the specified parameters

$bf    =  $CL -> boolean_flag ;        // $CL -> bf will also work

$dv    =  $CL -> double_value ;

$sp    =  $CL -> string_parameter ;

$files  =  $CL -> Files ;



output ( "Value of -boolean_flag              : $bf" ) ;

output ( "Value of -string_parameter          : $sp" ) ;

output ( "Value of -double_parameter          : $dv" ) ;

output ( "Files specified on the command line : " . implode ( ', ', $files ) ) ;

Files

File	Role	Description
`CL` (5 files, 3 directories)
`Examples` (2 files, 3 directories)
`Help` (1 file)
`CL.php`	Aux.	Auxiliary script
`LICENSE`	Lic.	License text
`NOTICE`	Data	Auxiliary data
`README.md`	Doc.	Documentation

Files

File	Role	Description
`Data` (1 file)
`Types` (18 files)
`Utilities` (15 files)
`CL.phpclass`	Class	Class source
`CLAbstractParameter.phpclass`	Class	Class source
`CLExceptions.phpclass`	Class	Class source
`CLParser.phpclass`	Class	Class source
`CLValidators.phpclass`	Class	Class source

Files

Data

File	Role	Description
`ColorNames.txt`	Data	Auxiliary data

Files

Types

File	Role	Description
`Boolean.phpclass`	Class	Class source
`Color.phpclass`	Class	Class source
`CommandLine.phpclass`	Class	Class source
`DateTime.phpclass`	Class	Class source
`File.phpclass`	Class	Class source
`Flag.phpclass`	Class	Class source
`Internet.phpclass`	Class	Class source
`Keyword.phpclass`	Class	Class source
`List.phpclass`	Class	Class source
`Measure.phpclass`	Class	Class source
`Numeric.ini`	Data	Auxiliary data
`Numeric.phpclass`	Class	Class source
`Range.phpclass`	Class	Class source
`Set.phpclass`	Class	Class source
`SortOptions.phpclass`	Class	Class source
`Standard.phpclass`	Class	Class source
`String.phpclass`	Class	Class source
`Types.ini`	Data	Auxiliary data

Files

Utilities

File	Role	Description
`AsciiReport.phpclass`	Class	Class source
`Colors.phpclass`	Class	Class source
`Console.phpclass`	Class	Class source
`Convert.phpclass`	Class	Class source
`Debug.phpclass`	Class	Class source
`Encoder.phpclass`	Class	Class source
`Formatting.phpclass`	Class	Class source
`GenericWrapper.phpclass`	Class	Class source
`IniFile.phpclass`	Class	Class source
`Path.phpclass`	Class	Class source
`PHP.phpclass`	Class	Class source
`Regex.phpclass`	Class	Class source
`SimpleXML.phpclass`	Class	Class source
`String.phpclass`	Class	Class source
`Vector.phpclass`	Class	Class source

Files

Examples

File	Role	Description
`00.readme` (1 file)
`01.general` (1 file)
`common` (13 files)
`examples.inc.php`	Aux.	Auxiliary script
`README.md`	Doc.	Documentation

Files

Examples

00.readme

File	Role	Description
`example.php`	Example	Example script

Files

Examples

01.general

File	Role	Description
`example.php`	Example	Example script

Files

Examples

common

File	Role	Description
`aliases.bad.php`	Example	Example script
`aliases.good.php`	Example	Example script
`arguments.php`	Example	Example script
`default.php`	Example	Example script
`help-group.php`	Example	Example script
`help-text.php`	Example	Example script
`hidden.php`	Example	Example script
`multiple.php`	Example	Example script
`README.md`	Doc.	Documentation
`required.php`	Example	Example script
`usage.php`	Example	Example script
`validation-regex.php`	Example	Example script
`value-text.php`	Example	Example script

Files

Help

File	Role	Description
`Help.html`	Doc.	Documentation

	clparser-2022-10-21.zip 337KB
	clparser-2022-10-21.tar.gz 311KB
	Install with Composer

Version Control

Unique User Downloads

Download Rankings

100%

Total:	122
This week:	0

All time:	9,423
This week:	48

User Ratings

	All time
Utility:	93%
Consistency:	93%
Documentation:	93%
Examples:	93%
Tests:	-
Videos:	-
Overall:	75%
Rank:	139

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.