Documentation

Character extends Any

in package

• Alvine
• Types

Characterklasse zur Behandlung von Zeichen. Diese Klasse stellt oft benutze Zeichen als Konstanten zur Verfügung und bietet darüber hinaus Methoden für die Zeichenbehandlung. Als Standardzeichensatz wird in der Klasse UTF-8 verwendet.

Tags

category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine

since

20110904

Table of Contents

Constants

APIVERSION  = 1

Version der API-Version der Klasse.

CARRIAGERETURN  = "\r"

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

CRLF  = "\r\n"

CRLF

IDENTIFICATION  = 'Alvine'

Identifizierung der Alvine API

LINEFEED  = "\n"

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

LINEFEED_CR  = 0xd

MAC LineFeed

LINEFEED_FF  = 0xc

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

LINEFEED_LF  = 0xa

ASCII LineFeed

LINEFEED_LS  = 0x2028

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

LINEFEED_NEL  = 0x85

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

LINEFEED_PS  = 0xc

Paragraph Separator / Absatztrenner

SERIALVERSION  = 1

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  = "\t"

Alvine-Systemstandard Tab

VERSION  = 2

Generelle Alvine-Version

Properties

$hasAssociatedProperties  : boolean

$hash  : string

Eindeutige ID

$hasVolatileProperties  : boolean

$lineFeedMap  : array

$properties  : array

Methods

__call()  : mixed

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

__clone()  : mixed

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.

__get()  : mixed

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.

__isset()  : boolean

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

__serialize()  : array<string|int, mixed>

Serialization of the object and data. In the serialized object also stores meta-information for matching.

__set()  : void

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

__toString()  : string

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

__unserialize()  : void

__unset()  : mixed

Zurücksetzen von Werten

equals()  : boolean

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.

fromChar()  : int

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

fromInteger()  : string

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

getClass()  : string

Name der Klasse

getClone()  : Alvine

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

getClosure()  : Closure

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.

getHashCode()  : string

Die Methode Alvine::getID() verwenden!

getID()  : string

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

getLineFeeds()  : array

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

getShortID()  : string

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.

hasAssociatedProperties()  : boolean

Check if the object has associative properties

hasVolatileProperties()  : boolean

Prüfen ob das Objekt volatile Eigenschaften besitzt

isCallable()  : bool

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

isInstanceOf()  : boolean

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.

isLowerCase()  : boolean

Klein-/Großschreibung

isUpperCase()  : bool

Alias isUppercaseCase

isUppercaseCase()  : boolean

Klein-/Großschreibung

isWhitespace()  : boolean

Prüfen ob das Zeichen ein Whitespace ist

propertyExists()  : boolean

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

toLower()  : string

Alias für toLowerCase

toLowerCase()  : string

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

toUpper()  : string

Alias für toUpperCase

toUpperCase()  : string

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

__construct()  : mixed

Aus der Character-Klasse kann kein Objekt erstellt werden.

checkAndAdjustSerialisation()  : array<string|int, mixed>

Dealing with versions

// 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!

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

class MyObject extends Alvine {
}

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

echo (string) new MyObect();

class MyObject extends Alvine };

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

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

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

echo $obj->getClass();

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

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

$this instanceof $object

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