Packages a template for distribution.
Packages a template so that it can be distributed by the phpdocumentor
template repository.
This task accepts 2 arguments:
* The path to the template source files
* The short name for this template; this must be unique in phpDocumentor's
repository.
This task depends on PEAR's PEAR_PackageFileManager2 package.
| category |
phpDocumentor |
| package |
Tasks |
| subpackage |
Template |
| author |
Mike van Riel |
| license |
MIT |
| link |
http://phpdoc.org |
| copyright |
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
| version |
Release: @package_version@ |
Methods
If the method name is prefixed with 'get', it will try to find the
parameter in the options array.
__call(string $name, \string[] $arguments) : void | string
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::__call() |
Parameters
$name
stringName of the invoked method.
$arguments
\string[]Array with arguments passed to the method.
Returns
voidstring
Override constructor to temporarily wait with defining rules.
__construct() : void
Inherited
The first parameter is $rules, which may be a string for
gnu-style format, or a structured array for Zend-style format.
The second parameter is $argv, and it is optional. If not
specified, $argv is inferred from the global argv.
The third parameter is an array of configuration parameters
to control the behavior of this instance of Getopt; it is optional.
| inherited_from |
\phpDocumentor_Task_Abstract::__construct() |
Return the state of the option seen on the command line of the
current application invocation. This function returns true, or the
parameter to the option, if any. If the option was not given,
this function returns null.
__get(string $key) : string
Inherited
The magic __get method works in the context of naming the option
as a virtual member of this class.
| inherited_from |
\Zend_Console_Getopt::__get() |
| inherited_from |
\phpDocumentor_Task_Abstract::__get() |
Parameters
$key
string
Returns
string
Test whether a given option has been seen.
__isset(string $key) : boolean
Inherited
| inherited_from |
\Zend_Console_Getopt::__isset() |
| inherited_from |
\phpDocumentor_Task_Abstract::__isset() |
Parameters
$key
string
Returns
boolean
Set the value for a given option.
__set(string $key, string $value) : void
Inherited
| inherited_from |
\Zend_Console_Getopt::__set() |
| inherited_from |
\phpDocumentor_Task_Abstract::__set() |
Parameters
$key
string
$value
string
Return the current set of options and parameters seen as a string.
__toString() : string
Inherited
| inherited_from |
\Zend_Console_Getopt::__toString() |
| inherited_from |
\phpDocumentor_Task_Abstract::__toString() |
Returns
string
Unset an option.
__unset(string $key) : void
Inherited
| inherited_from |
\Zend_Console_Getopt::__unset() |
| inherited_from |
\phpDocumentor_Task_Abstract::__unset() |
Parameters
$key
string
Define additional command-line arguments.
addArguments(array $argv) : \Zend_Console_Getopt
Inherited
These are appended to those defined when the constructor was called.
| inherited_from |
\Zend_Console_Getopt::addArguments() |
| inherited_from |
\phpDocumentor_Task_Abstract::addArguments() |
Parameters
$argv
array
Exceptions
Returns
Adds an option rule to the application.
addOption(\string[] | string $flags, string $parameter_type, string $description) : void
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::addOption() |
Parameters
$flags
\string[]stringSet of flags to support for this option.
$parameter_type
stringMay be nothing, or an string (s), word (w) or integer (i) prefixed with the availability specifier (- for optional and = for required).
$description
stringHelp text
Define additional option rules.
addRules(array $rules) : \Zend_Console_Getopt
Inherited
These are appended to the rules defined when the constructor was called.
| inherited_from |
\Zend_Console_Getopt::addRules() |
| inherited_from |
\phpDocumentor_Task_Abstract::addRules() |
Parameters
$rules
array
Returns
Executes the transformation process.
execute() : void
Return the state of the option seen on the command line of the
current application invocation.
getOption(string $flag) : mixed
Inherited
This function returns true, or the parameter value to the option, if any.
If the option was not given, this function returns false.
| inherited_from |
\Zend_Console_Getopt::getOption() |
| inherited_from |
\phpDocumentor_Task_Abstract::getOption() |
Parameters
$flag
string
Returns
mixed
Return a list of options that have been seen in the current argv.
getOptions() : array
Inherited
| inherited_from |
\Zend_Console_Getopt::getOptions() |
| inherited_from |
\phpDocumentor_Task_Abstract::getOptions() |
Returns
array
Return the arguments from the command-line following all options found.
getRemainingArgs() : array
Inherited
| inherited_from |
\Zend_Console_Getopt::getRemainingArgs() |
| inherited_from |
\phpDocumentor_Task_Abstract::getRemainingArgs() |
Returns
array
Returns the usage description or null if none is set.
getUsageDescription() : string | null
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::getUsageDescription() |
Returns
stringnull
Generates the usage / help message.
getUsageMessage() : string
Inherited
Note that this usage information is provided in most Exceptions
generated by this class.
| inherited_from |
\phpDocumentor_Task_Abstract::getUsageMessage() |
Returns
string
Version of the template to install
getVersion() : string
| magic |
|
| method |
Version of the template to install |
Returns
string
Parses the configuration options and populates the data store.
parse(bool $force) : null | \phpDocumentor_Task_Template_Package
Inherited
Also find option parameters, and remaining arguments after
all options have been parsed.
| inherited_from |
\phpDocumentor_Task_Abstract::parse() |
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$force
boolif true; forces parsing independently of the _parsed property.
Returns
Define aliases for options.
setAliases(array $aliasMap) : \Zend_Console_Getopt
Inherited
The parameter $aliasMap is an associative array
mapping option name (short or long) to an alias.
| inherited_from |
\Zend_Console_Getopt::setAliases() |
| inherited_from |
\phpDocumentor_Task_Abstract::setAliases() |
Parameters
$aliasMap
array
Exceptions
Returns
Define full set of command-line arguments.
setArguments(array $argv) : \Zend_Console_Getopt
Inherited
These replace any currently defined.
| inherited_from |
\Zend_Console_Getopt::setArguments() |
| inherited_from |
\phpDocumentor_Task_Abstract::setArguments() |
Parameters
$argv
array
Exceptions
Returns
Additionally checks whether the given filename is readable.
setConfig(string $value) : void
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::setConfig() |
Parameters
$value
stringPath to the configuration file.
Exceptions
Define help messages for options.
setHelp(array $helpMap) : \Zend_Console_Getopt
Inherited
The parameter $help_map is an associative array
mapping option name (short or long) to the help string.
| inherited_from |
\Zend_Console_Getopt::setHelp() |
| inherited_from |
\phpDocumentor_Task_Abstract::setHelp() |
Parameters
$helpMap
array
Returns
Define one configuration option as a key/value pair.
setOption(string $configKey, string $configValue) : \Zend_Console_Getopt
Inherited
These are not program options, but properties to configure
the behavior of Zend_Console_Getopt.
| inherited_from |
\Zend_Console_Getopt::setOption() |
| inherited_from |
\phpDocumentor_Task_Abstract::setOption() |
Parameters
$configKey
string
$configValue
string
Returns
Define multiple configuration options from an associative array.
setOptions(array $getoptConfig) : \Zend_Console_Getopt
Inherited
These are not program options, but properties to configure
the behavior of Zend_Console_Getopt.
| inherited_from |
\Zend_Console_Getopt::setOptions() |
| inherited_from |
\phpDocumentor_Task_Abstract::setOptions() |
Parameters
$getoptConfig
array
Returns
Sets a description message for this task.
setUsageDescription(string $description) : void
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::setUsageDescription() |
Parameters
$description
stringmulti-line text with unlimited length.
Return the current set of options and parameters seen
as an array of canonical options and parameters.
toArray() : array
Inherited
Clusters have been expanded, and option aliases
have been mapped to their primary option names.
| inherited_from |
\Zend_Console_Getopt::toArray() |
| inherited_from |
\phpDocumentor_Task_Abstract::toArray() |
Returns
array
Return the current set of options and parameters seen in Json format.
toJson() : string
Inherited
| inherited_from |
\Zend_Console_Getopt::toJson() |
| inherited_from |
\phpDocumentor_Task_Abstract::toJson() |
Returns
string
Return the current set of options and parameters seen as a string.
toString() : string
Inherited
| inherited_from |
\Zend_Console_Getopt::toString() |
| inherited_from |
\phpDocumentor_Task_Abstract::toString() |
Returns
string
Return the current set of options and parameters seen in XML format.
toXml() : string
Inherited
| inherited_from |
\Zend_Console_Getopt::toXml() |
| inherited_from |
\phpDocumentor_Task_Abstract::toXml() |
Returns
string
Define legal options using the gnu-style format.
_addRulesModeGnu(string $rules) : void
Inherited
| inherited_from |
\Zend_Console_Getopt::_addRulesModeGnu() |
| inherited_from |
\phpDocumentor_Task_Abstract::_addRulesModeGnu() |
Parameters
$rules
string
Define legal options using the Zend-style format.
_addRulesModeZend(array $rules) : void
Inherited
| inherited_from |
\Zend_Console_Getopt::_addRulesModeZend() |
| inherited_from |
\phpDocumentor_Task_Abstract::_addRulesModeZend() |
Parameters
$rules
array
Exceptions
Return true if the parameter is in a valid format for
the option $flag.
_checkParameterType(string $flag, string $param) : bool
Inherited
Throw an exception in most other cases.
| inherited_from |
\Zend_Console_Getopt::_checkParameterType() |
| inherited_from |
\phpDocumentor_Task_Abstract::_checkParameterType() |
Parameters
$flag
string
$param
string
Exceptions
Returns
bool
Parse command-line arguments for a single long option.
_parseLongOption(mixed $argv) : void
Inherited
A long option is preceded by a double '--' character.
Long options may not be clustered.
| inherited_from |
\Zend_Console_Getopt::_parseLongOption() |
| inherited_from |
\phpDocumentor_Task_Abstract::_parseLongOption() |
Parameters
$argv
mixed
Parse command-line arguments for short options.
_parseShortOptionCluster(mixed $argv) : void
Inherited
Short options are those preceded by a single '-' character.
Short options may be clustered.
| inherited_from |
\Zend_Console_Getopt::_parseShortOptionCluster() |
| inherited_from |
\phpDocumentor_Task_Abstract::_parseShortOptionCluster() |
Parameters
Parse command-line arguments for a single option.
_parseSingleOption(string $flag, mixed $argv) : void
Inherited
| inherited_from |
\Zend_Console_Getopt::_parseSingleOption() |
| inherited_from |
\phpDocumentor_Task_Abstract::_parseSingleOption() |
Parameters
$flag
string
$argv
mixed
Exceptions
Configuration override for setting the parser visibility
getVisibility() : string
Inherited
By default it will use the command line options first, and then
look at the config file if no options have been supplied
| inherited_from |
\phpDocumentor_Task_Abstract::getVisibility() |
Returns
string
Hook method which is invoked right before all setters are invoked.
prePopulate() : void
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::prePopulate() |
Properties
Stores the command-line arguments for the calling applicaion.
$_argv : array
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_argv |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_argv |
Defaults for getopt configuration are:
ruleMode is 'zend' format,
dashDash (--) token is enabled,
ignoreCase is not enabled,
parseAll is enabled.
$_getoptConfig
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_getoptConfig |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_getoptConfig |
Stores options given by the user in the current invocation
of the application, as well as parameters given in options.
$_options : array
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_options |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_options |
State of the options: parsed or not yet parsed?
$_parsed : boolean
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_parsed |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_parsed |
Stores the name of the calling applicaion.
$_progname : string
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_progname |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_progname |
Stores the command-line arguments other than options.
$_remainingArgs : array
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_remainingArgs |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_remainingArgs |
Stores alternate spellings of legal options.
$_ruleMap : array
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_ruleMap |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_ruleMap |
Stores the list of legal options for this application.
$_rules : array
Inherited
| inherited_from |
\Zend_Console_Getopt::$$_rules |
| inherited_from |
\phpDocumentor_Task_Abstract::$$_rules |
<p>The name of this task including namespace</p>
$taskname : string
<p>The description used for usage</p>
$usage_description : string
Inherited
| inherited_from |
\phpDocumentor_Task_Abstract::$$usage_description |
Constants
CONFIG_DASHDASH
CONFIG_DASHDASH
Inherited
| inherited_from |
\Zend_Console_Getopt::CONFIG_DASHDASH |
| inherited_from |
\phpDocumentor_Task_Abstract::CONFIG_DASHDASH |
CONFIG_IGNORECASE
CONFIG_IGNORECASE
Inherited
| inherited_from |
\Zend_Console_Getopt::CONFIG_IGNORECASE |
| inherited_from |
\phpDocumentor_Task_Abstract::CONFIG_IGNORECASE |
CONFIG_PARSEALL
CONFIG_PARSEALL
Inherited
| inherited_from |
\Zend_Console_Getopt::CONFIG_PARSEALL |
| inherited_from |
\phpDocumentor_Task_Abstract::CONFIG_PARSEALL |
These are constants for optional behavior of this class.
CONFIG_RULEMODE
Inherited
ruleMode is either 'zend' or 'gnu' or a user-defined mode.
dashDash is true if '--' signifies the end of command-line options.
ignoreCase is true if '--opt' and '--OPT' are implicitly synonyms.
parseAll is true if all options on the command line should be parsed, regardless of
whether an argument appears before them.
| inherited_from |
\Zend_Console_Getopt::CONFIG_RULEMODE |
| inherited_from |
\phpDocumentor_Task_Abstract::CONFIG_RULEMODE |
MODE_GNU
MODE_GNU
Inherited
| inherited_from |
\Zend_Console_Getopt::MODE_GNU |
| inherited_from |
\phpDocumentor_Task_Abstract::MODE_GNU |
The options for a given application can be in multiple formats.
MODE_ZEND
Inherited
modeGnu is for traditional 'ab:c:' style getopt format.
modeZend is for a more structured format.
| inherited_from |
\Zend_Console_Getopt::MODE_ZEND |
| inherited_from |
\phpDocumentor_Task_Abstract::MODE_ZEND |
PARAM_OPTIONAL
PARAM_OPTIONAL
Inherited
| inherited_from |
\Zend_Console_Getopt::PARAM_OPTIONAL |
| inherited_from |
\phpDocumentor_Task_Abstract::PARAM_OPTIONAL |
Constant tokens for various symbols used in the mode_zend
rule format.
PARAM_REQUIRED
Inherited
| inherited_from |
\Zend_Console_Getopt::PARAM_REQUIRED |
| inherited_from |
\phpDocumentor_Task_Abstract::PARAM_REQUIRED |
TYPE_INTEGER
TYPE_INTEGER
Inherited
| inherited_from |
\Zend_Console_Getopt::TYPE_INTEGER |
| inherited_from |
\phpDocumentor_Task_Abstract::TYPE_INTEGER |
TYPE_STRING
TYPE_STRING
Inherited
| inherited_from |
\Zend_Console_Getopt::TYPE_STRING |
| inherited_from |
\phpDocumentor_Task_Abstract::TYPE_STRING |
TYPE_WORD
TYPE_WORD
Inherited
| inherited_from |
\Zend_Console_Getopt::TYPE_WORD |
| inherited_from |
\phpDocumentor_Task_Abstract::TYPE_WORD |