Overview

Namespaces

  • Alvine
    • Markup
      • Html
        • Constraint
        • Element
          • Html
          • Svg
        • Node
        • Operation
        • Tokenizer
          • State
          • Token
            • Util
        • TreeConstructor
          • InsertionMode

Classes

  • AbstractOperation
  • CacheObject
  • Component
  • Dataset
  • Document
  • Element
  • Engine
  • Fragment
  • InputStream
  • LoggerDefaultName
  • MissingTokenizerException
  • Node
  • NodeList
  • OpenElementsStack
  • Parser
  • ParserException
  • Tokenizer
  • TokenizerException
  • TokenStack
  • TreeConstructor

Interfaces

  • FromToken
  • Operation
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated

Class Engine

Die Template-Engine übersetzt Attribute Ausdrücke in Node-Strukturen. So können in eine statische HTML-Seite dynamiche Inhalte integriert werden.

<div data-replace="static:auto"></auto>
Alvine\Core\Alvine
Extended by Alvine\Markup\Html\Engine
Namespace: Alvine\Markup\Html
Package: Alvine\Markup\Html
Category: Alvine
License: Alvine Nutzungslizenz
Author: schukai GmbH info@schukai.de
Version: $Revision:$
Since: 20150205
Link: alvine.io
Located at Engine.class.php
Methods summary
public
# __construct( )

Neue Instanz erstellen

Neue Instanz erstellen

public Alvine\Markup\Html\Engine
# setAttributePrefix( string $prefix )

Setzt den Prefix

Setzt den Prefix

Um Kollisionen mit anderen Attributen zu vermeiden, kann man statt des Standard-Attributes data- einen eigenen Prefix z.B. data-my- setzen.

Parameters

$prefix

Returns

Alvine\Markup\Html\Engine
public Alvine\Markup\Html\Engine
# setCacheManager( Alvine\Cache\CacheManager $manager )

CacheManager setzen

CacheManager setzen

Parameters

$manager

Returns

Alvine\Markup\Html\Engine
public Alvine\Markup\Html\Engine
# removeMarkup( boolean $mode )

Standardmässig werden die Markups-Attribute entfernt. Über diese Methode kann das Verhalten geändert werden. wird die removeMarkup auf false gesetzt bleiben die Attribute erhalten.

Standardmässig werden die Markups-Attribute entfernt. Über diese Methode kann das Verhalten geändert werden. wird die removeMarkup auf false gesetzt bleiben die Attribute erhalten.

Parameters

$mode

Returns

Alvine\Markup\Html\Engine
public boolean
# shouldRemoveMarkup( )

Diese Methode liefert die Einstellung der Engine in Bezug auf das Entfernen von Attributen zurück.

Diese Methode liefert die Einstellung der Engine in Bezug auf das Entfernen von Attributen zurück.

Returns

boolean
public Alvine\Markup\Html\Engine
# raiseError( string $error )

Aufgetretenen Fehler melden

Aufgetretenen Fehler melden

Parameters

$error
Fehlermeldung

Returns

Alvine\Markup\Html\Engine
public string
# getAttributePrefix( )

Der Prefix, der in der HTML-Datei für die Markup-Operationen verwendet wird.

Der Prefix, der in der HTML-Datei für die Markup-Operationen verwendet wird.

Returns

string
Prefix
public Alvine\Markup\Html\Engine
# setDataset( Alvine\Markup\Html\Dataset $dataset )

Dataset setzen

Dataset setzen

Parameters

$dataset

Returns

Alvine\Markup\Html\Engine
public Alvine\Markup\Html\Dataset
# getDataset( )

Verwendetes Dataset

Verwendetes Dataset

Returns

Alvine\Markup\Html\Dataset
protected Alvine\Markup\Html\Engine
# processElement( Alvine\Markup\Html\Element $element )

Elemente bearbeiten

Elemente bearbeiten

Hinweis Die Klassennamen der Operations dürfen nicht CamelCase sein, da diese sonst auf Unix-Systemen nicht gefunden werden.

Parameters

$element

Returns

Alvine\Markup\Html\Engine
public Alvine\Markup\Html\NodeList
# getNodes( Alvine\Markup\Html\Fragment|Alvine\Markup\Html\Document|Alvine\Markup\Html\Node|string $html )

Nodes durchlaufen und die einzelnen Operationen durchführen.

Nodes durchlaufen und die einzelnen Operationen durchführen.

Als Ergebnis wird eine Nodestruktur zurückgegeben.

Wichtig: Wenn die Node-Struktur nicht für die weitere Bearbeitung verwendet werden soll, ist die Methode Enginde::getHTML() mit CacheManager ab dem zweiten Aufruf wesentlich schneller.

Parameters

$html

Returns

Alvine\Markup\Html\NodeList

Throws

Alvine\Core\UnsupportedException
public Alvine\Markup\Html\Engine
# setDebugNode( Alvine\Markup\Html\Element $element )

Debugnode setzen

Debugnode setzen

Parameters

$element

Returns

Alvine\Markup\Html\Engine
public string
# getHTML( Alvine\Markup\Html\Fragment|Alvine\Markup\Html\Document|Alvine\Markup\Html\Node|string $html )

HTML parsen und das Ergebnis als Zeichenkette zurückgeben. Diese Methode ruft Engine::getNodes() auf.

HTML parsen und das Ergebnis als Zeichenkette zurückgeben. Diese Methode ruft Engine::getNodes() auf.

WICHTIG: Bei der Verwendung des Cachemanagers muss darauf geachtet werden, dass das Dataset keine veränderlichen Daten wie Session-ID enthält! Diese Daten erlauben kein Caching.

Parameters

$html

Returns

string
HTML
Constants summary
string DEFAULTPREFIX

Prefix für die Attribute

Prefix für die Attribute

# 'data-'
Properties summary
protected Alvine\Markup\Html\Dataset $dataset
#
protected string $attributeprefix

Prefix

Prefix

#
protected array $error

Fehler

Fehler

#
protected boolean $removeMarkup

Markup-Attribute entfernen

Markup-Attribute entfernen

#
protected Alvine\Markup\Html\Element $debugNode
#
protected Alvine\I18n\Locale $locale
#
protected Alvine\Cache\CacheManager $cacheManager
#
alvine.markup.html API-Dokumentation 1.2.0 | © schukai GmbH | Impressum