1. class
  2. Alvine
  3. \
  4. Development
  5. \
  6. Upkeep
  7. \
  8. Representation
  9. \
  10. Part
  11. \
  12. Comment
  13. \
  14. Tag
  15. \
  16. ParamTag

ParamTag

class ParamTag extends Tag

Parameter

@param \string name descripton

Properties

protected string $label from Tag
protected string $type
protected string $name
protected string $description

Methods

__construct(string $type, string $name, string $description = null)

Neues Objekt

string
getLabel()

Bezeichnung

from Tag
static Tag
getInstanceFromArray(array $args)

Instanz erstellen

string
__toString()

Repräsentation des Tags

string
getName()

Name

string
getDescription()

Beschreibung

string
getType()

Typ

string
getFormattedName()

Name mit $-Zeichen und Leerzeichen

string
getFormattedDescription()

Beschreibung

string
getFormattedType()

Typ mit Leerzeichen

string
getSource(integer $typeWhitespace = null, integer $nameWhitespace = null)

Parameter-Tag

Details

at line 62
__construct(string $type, string $name, string $description = null)

Neues Objekt

Parameters

string $type Typ
string $name Name (ohne $)
string $description Beschreibung

in Tag at line 68
string getLabel()

Bezeichnung

Return Value

string Bezeichnung

at line 133
static Tag getInstanceFromArray(array $args)

Instanz erstellen

Parameters

array $args Argumente

Return Value

Tag

at line 176
string __toString()

Repräsentation des Tags

Return Value

string Zeichenkette

at line 77
string getName()

Name

Return Value

string Name

at line 86
string getDescription()

Beschreibung

Return Value

string Beschreibung

at line 95
string getType()

Typ

Return Value

string Type

at line 104
string getFormattedName()

Name mit $-Zeichen und Leerzeichen

Return Value

string Name

at line 113
string getFormattedDescription()

Beschreibung

Return Value

string Beschreibung

at line 122
string getFormattedType()

Typ mit Leerzeichen

Return Value

string Type

at line 158
string getSource(integer $typeWhitespace = null, integer $nameWhitespace = null)

Parameter-Tag

Erstellt einen Parameter-Block mit definierten Abständen zwischen den einzelnen Spalten, damit diese alle untereinander stehen. Als Parameter kann die gewünschte Länge des Blocks angegebene werden.

Parameters

integer $typeWhitespace Länge des Types
integer $nameWhitespace Länge des Namens

Return Value

string Repräsentation des Tags