File: Examples/common/required.php

Recommend this page to a friend!
  Classes of Christian Vigh  >  PHP Command Line Arguments Parser  >  Examples/common/required.php  >  Download  
File: Examples/common/required.php
Role: Example script
Content type: text/plain
Description: Example script
Class: PHP Command Line Arguments Parser
Parse and extract arguments from the command line
Author: By
Last change:
Date: 4 years ago
Size: 1,095 bytes
 

Contents

Class file image Download
<?php
   
/***
        This example defines a command line accepting one REQUIRED parameter, -string_value.

        Note that you reserved parameters such as -help are processed first, so it's not necessary
        to supply required values for displaying command-line help ; thus, the following will not
        throw an exception but simply display command-line help :

            $ php required.php -help
     ***/
   
require_once ( dirname ( __FILE__ ) . '/../examples.inc.php' ) ;

   
$definitions = <<<END
<command>
    <usage>
        Example script that demonstrates the usage of the "required" attribute.
        Run it without any parameter ; An exception will be thrown because the -string_value parameter
        is required :

            \$ php required.php

        Then with a value specified for the -string_value parameter :

            \$ php default.php -string_value "hello world"
    </usage>

    <string name="string_value, sv" required="true">
        Help for the string_value parameter.
    </string>
</command>
END;

   
$cl = new CLParser ( $definitions ) ;
    echo
"Value of the -string_value parameter : {$cl -> string_value}\n" ;


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