Xinc-Config
[ class tree: Xinc-Config ] [ index: Xinc-Config ] [ all elements ]

Class: Xinc_Config_Getopt

Source Location: /Xinc/Config/Getopt.php

Class Overview


Command-line options parsing class.


Author(s):

Copyright:

  • 2002-2007 Sebastian Bergmann <sb@sebastian-bergmann.de>

Methods



Class Details

[line 44]
Command-line options parsing class.



Tags:

author:  Jamie Talbot
author:  Andrei Zmievski <andrei@php.net>
author:  Sebastian Bergmann <sb@sebastian-bergmann.de>
copyright:  2002-2007 Sebastian Bergmann <sb@sebastian-bergmann.de>
license:  BSD License


[ Top ]


Class Methods


static method getopt [line 55]

static unknown getopt( array $args, unknown_type $shortOptions, [unknown_type $longOptions = null])

Enter description here...



Tags:

throws:  Xinc_Config_Exception_Getopt
access:  public


Parameters:

array   $args  
unknown_type   $shortOptions  
unknown_type   $longOptions  

[ Top ]

static method parseLongOption [line 146]

static void parseLongOption( string $arg, $longOptions, &$opts, &$args, array $long_options, array $opts, array $args)

Parses long options from the command line.



Tags:

throws:  Xinc_Config_Exception_Getopt If the option is unrecognised, or missing a required value, or ambiguous.
access:  protected


Parameters:

string   $arg   The argument to parse.
array   $long_options   Long options to match.
array   $opts   The options accumulator.
array   $args   The arguments passed to the option.
   $longOptions  
   &$opts  
   &$args  

[ Top ]

static method parseShortOption [line 106]

static void parseShortOption( string $arg, $shortOptions, &$opts, &$args, string $short_options, array $opts, array $args)

Parses short options from the command line.



Tags:

throws:  Xinc_Config_Exception_Getopt If the option is unrecognised, or missing a required value.
access:  protected


Parameters:

string   $arg   The argument to parse.
string   $short_options   Short options to match.
array   $opts   The options accumulator.
array   $args   The arguments passed to the option.
   $shortOptions  
   &$opts  
   &$args  

[ Top ]


Documentation generated on Sun, 09 Dec 2012 21:49:26 +0100 by phpDocumentor 1.4.4