class ASCII extends Character

ASCII

Abbildung der ASCII Sonder-Zeichen und Bereitstellung von Funktionen. Da das Alvine-Framework grundsätzlich mit UTF-8 arbeitet, verwendet die Klasse UTF-8 funktionen.

Traits

SerializableImplementation

Constants

VERSION

Generelle Alvine-Version

APIVERSION

Version der API-Version der Klasse.

IDENTIFICATION

Identifizierung der Alvine API

SERIALVERSION

Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren.

TAB

Horizontaltabulator

LINEFEED

Alvine-Systemstandard Zeilenumbruch http://www.fileformat.info/info/unicode/char/0a/index.htm

CARRIAGERETURN

Zeilenumbruch http://www.fileformat.info/info/unicode/char/0d/index.htm

CRLF

CRLF

LINEFEED_FF

Form Feed / Seitenvorschub (mit zwangsläufigem Umbruch der Zeile) UTF-8 HEX 0c http://www.fileformat.info/info/unicode/char/0c/index.htm

LINEFEED_NEL

New Line / Neue Zeile UTF-8 HEX 0xC2 0x85

LINEFEED_LS

Line Separator / Zeilentrenner UTF-8 HEX-Darstellung 0xE2 0x80 0xA8

LINEFEED_PS

Paragraph Separator / Absatztrenner

LINEFEED_LF

ASCII LineFeed

LINEFEED_CR

MAC LineFeed

NUL

NULL-Zeichen. Wird vor allem verwendet um Abschnitte in Datenströmen zu Kennzeichnen. Hat aber nur Auswirkungen, wenn speziell nach diesen gesucht wird.

SOH

Anfang Dokumentkopf

STX

Textanfang

ETX

Textende

EOT

Ende der Übertragung

ENQ

Rückfrage - Zeichen um anzudeuten, dass eine Rückmeldung gewünscht ist.

ACK

Bestätigung - Hinweis, dass Sender Nachricht empfangen hat.

BEL

Klingel/Glocke/Tonsignal

BS

BS Backspace

LF

LF Line Feed - horizontalen Zeilenvorschub in nächste Zeile übernehmen.

VT

Vertikaltabulator

FF

Seitenvorschub/neue Seite

CR

Wagenrücklauf - Entfernt alle Tabulatoren und setzte Cursor auf die erste Position in der Zeile.

SO

Breitschrift

SI

Engschrift

DLE

DLE

DC1

Gerätesteuerung 1

DC2

Gerätesteuerung 2

DC3

Gerätesteuerung 3

DC4

Gerätesteuerung 4

NAK

NAK Negative Acknowlegdement - Empfänger teilt negative Antwort mit.

SYN

Synchronisationssignal

ETB

Ende des Übertragungsblocks

CAN

Abbruch

EM

Ende des Mediums

SUB

Ersetzen

ESC

Escape

FS

Dateitrenner

GS

Gruppentrenner

RS

Datensatztrenner

US

Einheitentrenner

SP

SP Space - Leerzeichen

DEL

DEL

CSI

CSI - Control Sequence Introducer

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
static protected array $lineFeedMap from Character

Methods

string
serialize()

Serialisieren

boolean
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

boolean
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

unserialize(string $serialization)

Klasse deserialisieren

string
__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

from Alvine
void
__set(string $name, mixed $value)

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

from Alvine
boolean
__isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

from Alvine
__unset(string $name)

Zurücksetzen von Werten

from Alvine
mixed
__get(string $name)

Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.

from Alvine
getClosure(string $name)

Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.

from Alvine
boolean
propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

from Alvine
mixed
__call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

from Alvine
boolean
isCallable(type $name)

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

from Alvine
string
getID()

Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.

from Alvine
string
getShortID(integer $length = null)

Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.

from Alvine
boolean
equals(Alvine $object)

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von Alvine::getID() zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.

from Alvine
Alvine
getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

from Alvine
__clone()

Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.

from Alvine
string
getClass()

Name der Klasse

from Alvine
boolean
isInstanceOf(object $object)

Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.

from Alvine
__construct()

Aus der Character-Klasse kann kein Objekt erstellt werden.

from Character
static array
getLineFeeds()

Diese Methode gibt alle in UTF-8 definierten Zeilenumbrüche als Array zurück.

from Character
static string
toLowerCase($char)

Diese Funktion wandelt ein großgeschriebenes Zeichen in ein kleingeschriebenes um: A -> a

from Character
static string
toUpperCase($char)

Diese Funktion wandelt ein kleines Zeichen in ein großes um a -> A.

from Character
static string
fromInteger(integer $code)

Diese Methode wandelt eine Integerzahl in das entsprechenden UTF-Zeichen um.

from Character
static int
fromChar(string $char)

Diese Methode gibt den Integerwert eines UTF-8 Zeichens zurück.

from Character
static boolean
isWhitespace(string $char)

Prüfen ob das Zeichen ein Whitespace ist

from Character
static boolean
isLowerCase(string $char)

Klein-/Großschreibung

from Character
static boolean
isUppercaseCase(string $char)

Klein-/Großschreibung

from Character

Details

string serialize()

Serialisieren

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert. Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.

Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.

Return Value

string String-Repräsentation des Objektes

boolean hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

boolean

boolean hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

boolean

protected checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.

Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

unserialize(string $serialization)

Klasse deserialisieren

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Parameters

string $serialization Serialisierte Daten

Exceptions

UnserializeException Exception

in Alvine at line 178
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

in Alvine at line 212
void __set(string $name, mixed $value)

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.

class MyObject extends Alvine {
}

$obj = new MyObject();
$obj->myValue = 4;

Parameters

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 223
boolean __isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Parameters

string $name

Return Value

boolean

in Alvine at line 232
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 257
mixed __get(string $name)

Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

in Alvine at line 282
Closure getClosure(string $name)

Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 308
boolean propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 340
mixed __call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde.

// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction;  // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK');  // Ausgabe ist  OK!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 363
boolean isCallable(type $name)

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 377
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 397
string getID()

Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.

Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.

Diese Methode wird implizit beim Serialisieren aufgerufen.

Die UUID ist dabei vom Type4 (Random)

Return Value

string UUID des Objektes

in Alvine at line 416
string getShortID(integer $length = null)

Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.

Diese Methode ist hilreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.

Parameters

integer $length Länge der ID

Return Value

string Hashwert des Objektes

in Alvine at line 442
boolean equals(Alvine $object)

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von Alvine::getID() zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.

class MyObject extends Alvine {};

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

in Alvine at line 463
Alvine getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.

Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

in Alvine at line 475
__clone()

Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

in Alvine at line 493
string getClass()

Name der Klasse

class MyObject extends Alvine {};
$obj = new MyObject();

echo $obj->getClass();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

in Alvine at line 518
boolean isInstanceOf(object $object)

Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.

if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object

Parameters

object $object

Return Value

boolean

in Character at line 112
protected __construct()

Aus der Character-Klasse kann kein Objekt erstellt werden.

in Character at line 125
static array getLineFeeds()

Diese Methode gibt alle in UTF-8 definierten Zeilenumbrüche als Array zurück.

Return Value

array Liste mit den Zeilenumbrüchen.

in Character at line 146
static string toLowerCase($char)

Diese Funktion wandelt ein großgeschriebenes Zeichen in ein kleingeschriebenes um: A -> a

Parameters

$char

Return Value

string Kleines Zeichen

in Character at line 156
static string toUpperCase($char)

Diese Funktion wandelt ein kleines Zeichen in ein großes um a -> A.

Parameters

$char

Return Value

string Kleines Zeichen

in Character at line 168
static string fromInteger(integer $code)

Diese Methode wandelt eine Integerzahl in das entsprechenden UTF-Zeichen um.

Parameters

integer $code Integerzahl des Zeichen

Return Value

string UTF-8 Zeichen

in Character at line 179
static int fromChar(string $char)

Diese Methode gibt den Integerwert eines UTF-8 Zeichens zurück.

Parameters

string $char UTF-8 Zeichen

Return Value

int Code

in Character at line 193
static boolean isWhitespace(string $char)

Prüfen ob das Zeichen ein Whitespace ist

Parameters

string $char Zeichen

Return Value

boolean Ergebnis

in Character at line 210
static boolean isLowerCase(string $char)

Klein-/Großschreibung

Prüfen ob das Zeichen klein ist, oder keine Groß-Kleinschreibung hat. A ergibt false a ergibt true ? ergibt false, da es keinen Fall hat

Parameters

string $char Zeichen

Return Value

boolean Ergebnis

in Character at line 228
static boolean isUppercaseCase(string $char)

Klein-/Großschreibung

Prüfen ob das Zeichen klein ist, oder keine Groß-Kleinschreibung hat. A ergibt true a ergibt false ? ergibt false, da es keinen Fall hat

Parameters

string $char Zeichen

Return Value

boolean Ergebnis