Namespaces

PHP
PhpOptions
- Types

Classes

Exceptions

Class Options

Class for better work with PHP comand-line options

Namespace: PhpOptions
Author: Viktor Mašíček <viktor@masicek.net>
Located at Options.php

Methods summary
`public`	# `__construct( )` Control that script run from command line Control that script run from command line Throws `PhpOptions\UserBadCallException` Script have to run from command line.
`public static array`	# `arguments( )` Return array of arguments in command-line. Return array of arguments in command-line. Returns `array`
`public PhpOptions\Options`	# `add( array\|PhpOptions\Option $options = array() )` Add option Add option Parameters `$options` `array\|PhpOptions\Option` Added options Returns `PhpOptions\Options`
`public PhpOptions\Options`	# `defaults( string $name )` Set default option if any options is set Set default option if any options is set Parameters `$name` `string` Name of option Returns `PhpOptions\Options` Throws `PhpOptions\InvalidArgumentException` Unknown option.
`public PhpOptions\Options`	# `description( string $description )` Set text of common description in generated help Set text of common description in generated help Parameters `$description` `string` Text of common description Returns `PhpOptions\Options`
`public mixed`	# `get( string $name )` Return value of option. For set option without value return TRUE. If option is not set, return FALSE. Return value of option. For set option without value return TRUE. If option is not set, return FALSE. Parameters `$name` `string` Name of option or short or long option with prefix ('-' or '--') Returns `mixed` Throws `PhpOptions\InvalidArgumentException` Unknown option
`public PhpOptions\Options`	# `dependences( string $main, string\|array $needed, string $groupName = NULL )` Define dependences of options. Define dependences of options. Parameters `$main` `string` Main option for which we define needed options `$needed` `string\|array` Needed options for main option `$groupName` `string` Name of group into which put all options (main + needed) Returns `PhpOptions\Options` Throws `PhpOptions\InvalidArgumentException` Unknown option `PhpOptions\UserBadCallException` Some option need some another option
`public PhpOptions\Options`	# `group( string $name, string\|array $options )` Define groups of options Define groups of options Parameters `$name` `string` Name of group `$options` `string\|array` List of options names Returns `PhpOptions\Options`
`public string`	# `getHelp( $maxLength = PhpOptions\Options::HELP_MAX_LENGTH )` Return "help" made from descriptions of options Return "help" made from descriptions of options Returns `string`

Constants summary
`string`	`VERSION`	`'1.3.0'`	# Version of PhpOptions Version of PhpOptions
`integer`	`HELP_MAX_LENGTH`	`75`	# Max length of one line Max length of one line