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

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition:

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

Protected Attributes
	$name = ''
	$required = FALSE
	$description = ''

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Represents a CommandArgumentDefinition

http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later

Definition at line 21 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)
boolean	$required	defines whether this argument is required or optional
string	$description	description of the argument

Definition at line 45 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()

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()

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

(

)

Returns

string

Definition at line 72 of file CommandArgumentDefinition.php.

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

getName()

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

(

)

Returns

string

Definition at line 54 of file CommandArgumentDefinition.php.

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

isRequired()

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

(

)

Returns

string

Definition at line 79 of file CommandArgumentDefinition.php.

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

Member Data Documentation

$description

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

protected

Definition at line 36 of file CommandArgumentDefinition.php.

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

$name

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

TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition::$required = FALSE

protected

Definition at line 31 of file CommandArgumentDefinition.php.

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