Page
class Page extends View
Seiten-View einer Webanwendung
Der View für Webanwendungen erweitert den Standard-View mit alle für die Darstellung der Anwendungsdaten relevanten Methoden und Eigenschaften.
Je nach Angeforderten MediaType (MimeType) wird ein View erstellt, oder ein View mit StatusCode HTTP_UNSUPPORTED_MEDIA_TYPE (415) erstellt.
Mit Hilfe der Methode View::getDefaultInstance() kann ein Standard-View erstellt und zurückgeliefert werden. Dies ist dann sinnvoll, wenn man für bestimmte Abfragen noch keine Funktionalität implementiert hat, dem Anwender aber einen Hinweis geben möchte.
Constants
| LINK_PREFIX |
Vorsilbe für Linkplatzhalter |
| LINK_URL_SUFFIX |
URL |
| LINK_LABEL_SUFFIX |
Label |
| LINK_ID_SUFFIX |
ID |
| LINK_RELATION_SUFFIX |
Relation |
| LINK_DELIMITER |
Trennzeichen |
Properties
| protected Content | $content | from View | |
| protected StatusCode | $statusCode | from View | |
| protected SimpleMap | $header | from View |
Methods
Internationalisierung
Instanz aus einer Map erstellen
Pfad und Dateiname des Templates
Diese Methode erstellt aus einem Template, das im Verzeichnis resource/template/[Klassenpfad] liegen muß ein neuen Standard-View.
Details
in View at line 104
__construct(Content $content)
Neues View initialisieren
in View at line 118
Content
getContent()
Inhalt
in View at line 154
View
setLocation(URI $uri, boolean $permanent = true)
Umleitung setzen
Hinweis: Bei 302 ist das Ändern der Methode vom Client abhängig.
in View at line 193
ResponseHeader
getHeader()
Zugriff auf die Header
in View at line 202
StatusCode
getHttpStatusCode()
StatusCode
in View at line 234
static string
replaceI18N(string $content, Presenter $presenter, string $quoteCharList = null)
Internationalisierung
Die Platzhalter müssen mit i18n anfangen:
i18n{mykeytoreplace}
Die Eigenschaft muss dann mit dem Schlüssel angelegt werden:
mykeytoreplace=Text
In der Anwendungskonfiguration kann der Schlüssel application.web.i18n.showkeys auf true gesetzt werden.
Wird die Zeichenkette $quoteCharList übergeben, so werden alle Zeichen die darin enthalten sind mit einem Backslash versehen. Diese Funktion verwendet die PHP Version \addcslashes
in View at line 273
static protected Map
setLinksPlaceholder(Presenter $presenter, Map $map)
Link-Map initialisieren
Sind in der Route Links definiert, so stehen diese als Platzhalter
im Template zur Verfügung. Der Schlüssel der Links setzt sich aus
link-
in View at line 331
static protected View
getInstanceFromMap(Presenter $presenter, Map $map, ParameterMap $parameter = null)
Instanz aus einer Map erstellen
Template
Wird kein Template definiert, bzw ist dieses Leer wird nur ein leerer Platzhalter mit dem Namen content verwendet.
Über die Platzhalter template kann der Dateiname des Templates ohne Erweiterung (ohne .html) angegeben werden. Über den Schlüssel resourcepath kann der Pfad auf die Templates gesetzt werden.
Ist das Template nicht vorhanden, so wird ein HTTPError erstellt und der Inhalt zurückgegeben.
Links
Sind in der Route Links definiert, so stehen diese als Platzhalter
im Template zur Verfügung. Der Schlüssel der Links setzt sich aus
link-
Parameter
Die übergebenen Parameter stehen mit dem Schlüssel der Parameter zur Verfügung. Das ObjektMap muss eine Limitation auf \Alvine\Types\Parameter besitzen. Ansonsten werden die Parameter nicht ausgewertet.
Die Werte in den Parametern überschreiben die Werte in der Map. Wenn das nicht gewüscht ist, wird $parameter nicht übergeben.
in View at line 393
static protected File
getTemplateFileAndMimeType(Presenter $presenter, Map $map = null, ParameterMap $parameter = null)
Pfad und Dateiname des Templates
Im Parameter können die Werte template und resourcepath übergeben werden. Wird nichts übergeben werden die Defaultwerte default für das Template und als Pfad der in der Config definierte genommen.
Das Ergebnis muss noch mit $templateFile->exists() auf Exitenz geprüft erden.
Der Aufruf erfolgt folgendermaßen
list($templateFile, $mediaType, $originTemplateFileForLogging) = static::getTemplateFileAndMimeType($presenter, $map, $parameter);
at line 77
static View
getInstance(Presenter $presenter, Generic $model)
Diese Methode erstellt aus einem Template, das im Verzeichnis resource/template/[Klassenpfad] liegen muß ein neuen Standard-View.
Wird kein Template über die Parameter definiert, so wird das Template default.html verwendet.
Der Dateiname muss wie der MimeType der Anforderung lauten. Bei einer Anfrage mit dem MimeType text/html, heißt der Dateiname text.html. Bei einer JSON-Datei application.json
Wird kein passender Inhalt gefunden, so wird ein View mit StatusCode 415 (HTTP_UNSUPPORTED_MEDIA_TYPE) oder falls dieser auch nicht gefunden wird mit Status 500 (HTTP_INTERNAL_SERVER_ERROR) erstellt. Ohne Inhalt, wird nur der Inhalt "UNSUPPORTED MEDIA TYPE" zurück gegeben.
Die Templates für die Fehlerseiten liegen unter /resource/error/ und haben den Namen [statuscode].[mediatype], also z.B. 500.html
Über den Schlüssel resourcepath kann ein alternativer Pfad angegeben werden. Wird resourcepath nicht angegeben so wird der in der Konfiguration gesetzte Pfad verwendet.
Im Fehlerfall wird ein HTTPError Objekt zurückgegeben