1. class
  2. Alvine
  3. \
  4. Development
  5. \
  6. Upkeep
  7. \
  8. Render
  9. \
  10. ClassRender

ClassRender

class ClassRender extends Render

Erstellung des Klassen-Quelltextes

Diese Klasse erstellt aus einer Repräsentation einer Klasse einen Quelltext. Dieser Quelltext kann gespeichert und ausgeführt werden.

Constants

EXTENSION

Datei-Erweiterung für Klassen

Properties

protected string $description from Render
protected string $category from Render
protected MailAddress $author from Render
protected string $license from Render
protected Year $year from Render
protected integer $since from Render
protected Year $yearfrom from Render
protected string $version from Render
protected string $disclaimer from Render
$links from Render
protected string $representation Bezeichnung für die Referenz, die den Quelltext bearbeitet hat. from Render
protected Wrapper> $wrapper from Render
static protected string $fileTemplate from Render
static protected string $defaultDisclaimer from Render
static protected type $headerTemplate from Render
static protected string $sourceTemplate from Render
static protected string $keywordPrefix from Render
static protected string $alvineWrapperTemplate from Render

Methods

__construct(Representation $representation)

Neues Objekt

Render
initMetaFromComment(ClassComment $comment)

No description

from Render
string
wrapContent(string $name, string $content)

Inhalt einrahmen

from Render
string
getBodySource()

Body-Quelltext

from Render
string
getDefinitionSource()

Definition

from Render
string
__toString()

Ausgabe des Quelltextes

from Render
Render
addWrapper(Wrapper $wrapper)

Mittels Wrapper können um die einzelnen Blöcke: Konstanten, Eigenschaften, Konstruktor und Methoden Zeichenketten herumgelegt werden. Eine Anwendung ist zum Beispiel die Netbeans Folder-Markierung.

from Render
static InterfaceRender|ClassRender|TraitRender
getInstanceFromRepresentation(Representation $representation)

Instanz aus einer Representation erstellen

from Render
string
getSource()

Quelltext

string
getDescription()

getDescription

from Render
Render
setDescription(mixed $description)

setDescription

from Render
string
getCategory()

Kategorie

from Render
Render
setCategory(string $category)

Kategorie

from Render
MailAddress|null
getAuthor()

Autor

from Render
Render
setAuthor(MailAddress|null $author)

Autor

from Render
string
getLicense()

Lizenz

from Render
Render
setLicense(string $license)

Lizenz

from Render
$this
appendLink(URI $url, type $description)

Link

from Render
Render
setVersion(string $version)

Version

from Render
Year
getYear()

Jahreszahl

from Render
Render
setYear(Year $year)

Jahreszahl

from Render
integer
getSince()

Seit

from Render
Render
setSince(integer $since)

Seit

from Render
Year
getYearFrom()

Startjahr

from Render
Render
setYearFrom(Year $yearfrom)

Startjahr

from Render

Details

at line 52
__construct(Representation $representation)

Neues Objekt

Neues Objekt erstellen

Parameters

Representation $representation Representation

in Render at line 188
Render initMetaFromComment(ClassComment $comment)

Parameters

ClassComment $comment

Return Value

Render

in Render at line 234
protected string wrapContent(string $name, string $content)

Inhalt einrahmen

Der Inhalt wird an alle Wrapper die mittels Render::addWrapper hinzugefügt wurden übergeben.

Parameters

string $name Name
string $content Inhalt

Return Value

string Inhalt

in Render at line 251
protected string getBodySource()

Body-Quelltext

Return Value

string Quelltext des Bodies

in Render at line 328
protected string getDefinitionSource()

Definition

Zeichenkette mit der Definition erstellen

Return Value

string Quelltext

in Render at line 385
string __toString()

Ausgabe des Quelltextes

Return Value

string Quelltext

in Render at line 403
Render addWrapper(Wrapper $wrapper)

Mittels Wrapper können um die einzelnen Blöcke: Konstanten, Eigenschaften, Konstruktor und Methoden Zeichenketten herumgelegt werden. Eine Anwendung ist zum Beispiel die Netbeans Folder-Markierung.

Parameters

Wrapper $wrapper Wrapper

Return Value

Render

in Render at line 417
static InterfaceRender|ClassRender|TraitRender getInstanceFromRepresentation(Representation $representation)

Instanz aus einer Representation erstellen

Parameters

Representation $representation

Return Value

InterfaceRender|ClassRender|TraitRender

Exceptions

TypeException Kein bekannter Typ

at line 64
string getSource()

Quelltext

Return Value

string Zeichenkette

in Render at line 550
string getDescription()

getDescription

Return Value

string Beschreibung

in Render at line 561
Render setDescription(mixed $description)

setDescription

Parameters

mixed $description Beschreibung

Return Value

Render

in Render at line 571
string getCategory()

Kategorie

Return Value

string Kategorie

in Render at line 582
Render setCategory(string $category)

Kategorie

Parameters

string $category Kategorie

Return Value

Render

in Render at line 592
MailAddress|null getAuthor()

Autor

Return Value

MailAddress|null Autor

in Render at line 603
Render setAuthor(MailAddress|null $author)

Autor

Parameters

MailAddress|null $author Autor

Return Value

Render

in Render at line 613
string getLicense()

Lizenz

Return Value

string Lizenz

in Render at line 624
Render setLicense(string $license)

Lizenz

Parameters

string $license Lizenz

Return Value

Render

Link

Parameters

URI $url
type $description

Return Value

$this

in Render at line 649
Render setVersion(string $version)

Version

Parameters

string $version Lizenz

Return Value

Render

in Render at line 659
Year getYear()

Jahreszahl

Return Value

Year Jahreszahl

in Render at line 670
Render setYear(Year $year)

Jahreszahl

Parameters

Year $year Jahreszahl

Return Value

Render

in Render at line 680
integer getSince()

Seit

Return Value

integer seit

in Render at line 691
Render setSince(integer $since)

Seit

Parameters

integer $since Seit

Return Value

Render

in Render at line 701
Year getYearFrom()

Startjahr

Return Value

Year Jahr

in Render at line 712
Render setYearFrom(Year $yearfrom)

Startjahr

Parameters

Year $yearfrom Jahr

Return Value

Render