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

Render

abstract class Render extends Alvine

Erstellen von Quelltexten

Properties

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

Methods

__construct(Representation $representation)

Neuen Renderer

Render
initMetaFromComment(ClassComment $comment)

No description

string
wrapContent(string $name, string $content)

Inhalt einrahmen

string
getBodySource()

Body-Quelltext

string
getDefinitionSource()

Definition

string
__toString()

Ausgabe des Quelltextes

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.

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

Instanz aus einer Representation erstellen

string
getSource()

Quelldatei

string
getDescription()

getDescription

Render
setDescription(mixed $description)

setDescription

string
getCategory()

Kategorie

Render
setCategory(string $category)

Kategorie

MailAddress|null
getAuthor()

Autor

Render
setAuthor(MailAddress|null $author)

Autor

string
getLicense()

Lizenz

Render
setLicense(string $license)

Lizenz

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

Link

Render
setVersion(string $version)

Version

Year
getYear()

Jahreszahl

Render
setYear(Year $year)

Jahreszahl

integer
getSince()

Seit

Render
setSince(integer $since)

Seit

Year
getYearFrom()

Startjahr

Render
setYearFrom(Year $yearfrom)

Startjahr

Details

at line 165
__construct(Representation $representation)

Neuen Renderer

Neues Objekt mit dem übergebenen Quelltext

Parameters

Representation $representation Representation

at line 188
Render initMetaFromComment(ClassComment $comment)

Parameters

ClassComment $comment

Return Value

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

at line 251
protected string getBodySource()

Body-Quelltext

Return Value

string Quelltext des Bodies

at line 328
protected string getDefinitionSource()

Definition

Zeichenkette mit der Definition erstellen

Return Value

string Quelltext

at line 385
string __toString()

Ausgabe des Quelltextes

Return Value

string Quelltext

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

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 438
string getSource()

Quelldatei

Diese Methode erstellt den Sourcode für eine Klasse, Trait oder Interface.

Return Value

string Zeichenkette

Exceptions

RenderException

at line 550
string getDescription()

getDescription

Return Value

string Beschreibung

at line 561
Render setDescription(mixed $description)

setDescription

Parameters

mixed $description Beschreibung

Return Value

Render

at line 571
string getCategory()

Kategorie

Return Value

string Kategorie

at line 582
Render setCategory(string $category)

Kategorie

Parameters

string $category Kategorie

Return Value

Render

at line 592
MailAddress|null getAuthor()

Autor

Return Value

MailAddress|null Autor

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

Autor

Parameters

MailAddress|null $author Autor

Return Value

Render

at line 613
string getLicense()

Lizenz

Return Value

string Lizenz

at line 624
Render setLicense(string $license)

Lizenz

Parameters

string $license Lizenz

Return Value

Render

Link

Parameters

URI $url
type $description

Return Value

$this

at line 649
Render setVersion(string $version)

Version

Parameters

string $version Lizenz

Return Value

Render

at line 659
Year getYear()

Jahreszahl

Return Value

Year Jahreszahl

at line 670
Render setYear(Year $year)

Jahreszahl

Parameters

Year $year Jahreszahl

Return Value

Render

at line 680
integer getSince()

Seit

Return Value

integer seit

at line 691
Render setSince(integer $since)

Seit

Parameters

integer $since Seit

Return Value

Render

at line 701
Year getYearFrom()

Startjahr

Return Value

Year Jahr

at line 712
Render setYearFrom(Year $yearfrom)

Startjahr

Parameters

Year $yearfrom Jahr

Return Value

Render