TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition Class Reference

Public Member Functions
	__construct ($name, $required, $description)
string	getName ()
string	getDashedName ()
string	getDescription ()
string	isRequired ()

Protected Attributes
string	$name = ''
bool	$required = false
string	$description = ''

Detailed Description

Represents a CommandArgumentDefinition

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.

Definition at line 22 of file CommandArgumentDefinition.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::__construct	(		$name,
			$required,
			$description
	)

Constructor

Parameters

string	$name	‪name of the command argument (= parameter name)
bool	$required	‪defines whether this argument is required or optional
string	$description	‪description of the argument

Definition at line 43 of file CommandArgumentDefinition.php.

References TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\$description, TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\$name, and TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\$required.

Member Function Documentation

getDashedName()

string TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::getDashedName

(

)

Returns the lowercased name with dashes as word separator

Returns

‪string

Definition at line 63 of file CommandArgumentDefinition.php.

getDescription()

string TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::getDescription

(

)

Returns

‪string

Definition at line 73 of file CommandArgumentDefinition.php.

References TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\$description.

getName()

string TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::getName

(

)

Returns

‪string

Definition at line 53 of file CommandArgumentDefinition.php.

References TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\$name.

isRequired()

string TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::isRequired

(

)

Returns

‪string

Definition at line 81 of file CommandArgumentDefinition.php.

References TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\$required.

Member Data Documentation

$description

string TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::$description = ''

protected

Definition at line 34 of file CommandArgumentDefinition.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\__construct(), and TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\getDescription().

$name

string TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::$name = ''

protected

Definition at line 26 of file CommandArgumentDefinition.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\__construct(), and TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\getName().

$required

bool TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::$required = false

protected

Definition at line 30 of file CommandArgumentDefinition.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\__construct(), and TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition\isRequired().