[documentation] Add new API reference tree

Author: yannoff

doc/api/Application.md

@@ -0,0 +1,377 @@
+[« Back to Table Of Contents](/doc/api/index.md)
+
+# Class Argument
+
+**FQN:** [Yannoff\Component\Console\Definition\Argument][self]
+<br/>
+_**extends** [Item](/doc/api/Definition/Item.md)_
+<br/>
+
+
+## Overview
+
+*Argument definition item*
+<br/><br/>
+
+**Properties**
+
+- [$default](#argumentdefault)
+- [$hasDefault](#argumenthasDefault)
+- [$help](#argumenthelp)
+- [$name](#argumentname)
+- [$type](#argumenttype)
+
+**Methods**
+
+- [__construct()](#argument__construct)
+- [__toString()](#argument__toString)
+- [getDefault()](#argumentgetDefault)
+- [getHelp()](#argumentgetHelp)
+- [getName()](#argumentgetName)
+- [getSynopsis()](#argumentgetSynopsis)
+- [getType()](#argumentgetType)
+- [getValidTypes()](#argumentgetValidTypes)
+- [hasDefault()](#argumenthasDefault)
+- [isMandatory()](#argumentisMandatory)
+- [isOptional()](#argumentisOptional)
+- [isRequired()](#argumentisRequired)
+- [isValidType()](#argumentisValidType)
+- [setHasDefault()](#argumentsetHasDefault)
+
+---
+
+## Properties
+
+
+### <a name="default">Argument::$default</a>
+
+_Optional default value for the item_
+
+**type**: mixed <br/>
+**access**: protected <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#default)
+
+### <a name="hasDefault">Argument::$hasDefault</a>
+
+_Flag indicating if default value was set_
+
+**type**: [bool][php:bool] <br/>
+**access**: protected <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#hasDefault)
+
+### <a name="help">Argument::$help</a>
+
+_The item help/description message_
+
+**type**: [string][php:string] <br/>
+**access**: protected <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#help)
+
+### <a name="name">Argument::$name</a>
+
+_The item name_
+
+**type**: [string][php:string] <br/>
+**access**: protected <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#name)
+
+### <a name="type">Argument::$type</a>
+
+_The item type_
+
+**type**: [int][php:int] <br/>
+**access**: protected <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#type)
+
+---
+
+## Methods
+
+
+### <a name="__construct">Argument::__construct()</a>
+
+*Argument constructor.*
+
+**access:** public <br/>
+
+#### Arguments
+
+Name|Type|Description
+----|----|-----------
+$name|[string][php:string]|The argument name
+$type|[int][php:int]|The argument type: optional/required
+$help|[string][php:string]|The argument help message
+$default|mixed|Optional default value for the argument
+
+#### Return value
+
+>_No return value._
+
+
+#### Exceptions
+
+Type|Description
+----|-----------
+[InvalidArgumentTypeException](/doc/api/Exception/Definition/InvalidArgumentTypeException.md)|
+
+
+### <a name="__toString">Argument::__toString()</a>
+
+*Default to-string type-cast conversion for Item objects*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#__toString) <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [string][php:string]
+
+
+
+### <a name="getDefault">Argument::getDefault()</a>
+
+*Getter for the item default value*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#getDefault) <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** mixed
+
+
+
+### <a name="getHelp">Argument::getHelp()</a>
+
+*Getter for the item help message*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#getHelp) <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [string][php:string]
+
+
+
+### <a name="getName">Argument::getName()</a>
+
+*Getter for the item name*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#getName) <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [string][php:string]
+
+
+
+### <a name="getSynopsis">Argument::getSynopsis()</a>
+
+*Return the formatted help for the item*
+
+**access:** public <br/>
+
+#### Arguments
+
+Name|Type|Description
+----|----|-----------
+$tab|[string][php:string]|The tabulation string (defaults to `\t`)
+$width|[int][php:int]|Minimum width for the names column (defaults to `18`)
+
+#### Return value
+
+
+**type:** [string][php:string]
+
+
+
+### <a name="getType">Argument::getType()</a>
+
+*Getter for the item type*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#getType) <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [int][php:int]
+
+
+
+### <a name="getValidTypes">Argument::getValidTypes()</a>
+
+*Give the authorized values for the type property*
+
+**access:** public <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [array][php:array]
+
+
+
+### <a name="hasDefault">Argument::hasDefault()</a>
+
+*Getter for the hasDefault flag*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#hasDefault) <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [bool][php:bool]
+
+
+
+### <a name="isMandatory">Argument::isMandatory()</a>
+
+*True if the argument is required AND has no default value set<br/>Indeed a required argument with its default value set is de facto not mandatory*
+
+**access:** public <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [bool][php:bool]
+
+
+
+### <a name="isOptional">Argument::isOptional()</a>
+
+*True if the argument is typed as "optional"*
+
+**access:** public <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [bool][php:bool]
+
+
+
+### <a name="isRequired">Argument::isRequired()</a>
+
+*True if the argument is typed as required*
+
+**access:** public <br/>
+
+#### Arguments
+
+>_No arguments._
+
+#### Return value
+
+
+**type:** [bool][php:bool]
+
+
+
+### <a name="isValidType">Argument::isValidType()</a>
+
+*Check whether the given type as a valid value*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#isValidType) <br/>
+
+#### Arguments
+
+Name|Type|Description
+----|----|-----------
+$type|[int][php:int]|
+
+#### Return value
+
+
+**type:** [bool][php:bool]
+
+
+
+### <a name="setHasDefault">Argument::setHasDefault()</a>
+
+*Setter for the $hasDefault flag*
+
+**access:** public <br/>
+**inherited from:** [Item](/doc/api/Definition/Item.md#setHasDefault) <br/>
+
+#### Arguments
+
+Name|Type|Description
+----|----|-----------
+$hasDefault|[bool][php:bool]|
+
+#### Return value
+
+
+**type:** [self][self]
+
+
+
+
+[self]: Argument.md
+[php:array]: https://www.php.net/manual/language.types.array.php "PHP Built-in: array"
+[php:int]: https://www.php.net/manual/language.types.integer.php "PHP Built-in: int"
+[php:integer]: https://www.php.net/manual/language.types.integer.php "PHP Built-in: integer"
+[php:bool]: https://www.php.net/manual/language.types.boolean.php "PHP Built-in: bool"
+[php:true]: https://www.php.net/manual/language.types.boolean.php "PHP Built-in: true"
+[php:false]: https://www.php.net/manual/language.types.boolean.php "PHP Built-in: false"
+[php:boolean]: https://www.php.net/manual/language.types.boolean.php "PHP Built-in: boolean"
+[php:string]: https://www.php.net/manual/language.types.string.php "PHP Built-in: string"
+[php:float]: https://www.php.net/manual/language.types.float.php "PHP Built-in: float"
+[php:object]: https://www.php.net/manual/language.types.object.php "PHP Built-in: object"
+[php:null]: https://www.php.net/manual/language.types.null.php "PHP Built-in: null"
+[php:callable]: https://www.php.net/manual/language.types.callable.php "PHP Built-in: callable"
+[php:resource]: https://www.php.net/manual/language.types.resource.php "PHP Built-in: resource"
+[php:Closure]: https://www.php.net/manual/class.closure.php "PHP Built-in: Closure"
+[php:Error]: https://www.php.net/manual/class.error.php "PHP Built-in: Error"
+[php:Throwable]: https://www.php.net/manual/class.throwable.php "PHP Built-in: Throwable"
+[php:Exception]: https://www.php.net/manual/class.exception.php "PHP Built-in: Exception"
+[php:LogicException]: https://www.php.net/manual/class.logicexception.php "PHP Built-in: LogicException"
+[php:RuntimeException]: https://www.php.net/manual/class.runtimeexception.php "PHP Built-in: RuntimeException"
+
+[&laquo; Back to Table Of Contents](/doc/api/index.md)
+