abstract class Field extends Alvine

Definition eines Feldes

Diese Klasse kappselt die Informationen zu einem Datenbankfeld und dient zur abstraktion von Statements.

Abgeleitete Klassen müssen die Konstanten MAXLENGTH Maximale Länge eines Datenfeldes TYPE Name des Feldtypes definiteren

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.

MAXLENGTH

Maximale Länge. Ist das Feld -1, so ist keine Länge definiert.

IDENTIFIERSQUOTES

Feldnamentrenner

TYPE

Feldtype

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected string $table
protected string $name
protected string $alias
protected string $type
protected boolean $required
protected integer|null $length
protected string $comment
protected array $writehook
protected array $readhook
protected array $identifiersQuote

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)

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

string
__toString()

Feld als Zeichenkette

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(int|null $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(string $table, string $name, integer $length = null, string $alias = null, string $comment = null)

Erstellt neues Feldobjekt

setIdentifiersQuote($quoteChar)

Quote setzen, Standard ist ein Backtick für MySQL.

string
getTable()

Name der Tabelle

string
getName()

Name des Feldes

integer
getType()

Typ des Feldes

integer
getPDOType()

Wert für das Databindng

integer
getLength()

Längenbeschränkung

Field
setRequire()

Feld ist ein Pflichtfeld

Field
unsetRequire()

Pflichtfeld ausschalten

boolean
isRequired()

Ist Feld ein Pflichtfeld

string|null
getAlias()

Alias

string|null
getPropertyName()

Name des Properties (entweder das Alias oder der Name des SQL-Feldes)

string|null
getComment()

Kommentar

Field
addReadHook(Closure $converter)

Callback, um Werte für die Speicherung umzustellen und in das Format des Storage-Provider zu bringen. Der Callback muss als Parameter einen Wert und als Rückgabewert ebenfalls einen Wert enthalten.

Field
addWriteHook(Closure $converter)

Callback, um Werte von der Speicherung umzustellen und in das Format des Models zu bringen. Der Callback muss als Parameter einen Wert und als Rückgabewert ebenfalls einen Wert enthalten.

mixed
getPostProcessedData(mixed $value)

Konvertiert Wert die in der Datenbank stehen in das Zielformat. Die Methoden können mittels addReadHook an ein Feld gehängt werden.

mixed
getPreparedData(mixed $value)

Konvertiert Wert für die Datenbank, so das die Datenbank diese Versteht. Die Methoden können per addWriteHook angehängt werden.

string
asString()

SQL-Statement als Zeichenkette ohne Alias

string
asStringWithAlias()

SQL-Statement als Zeichenkette mit Alias ´A´

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)

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

at line 350
string __toString()

Feld als Zeichenkette

Return Value

string Daten des Objekts

in Alvine at line 210
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 221
boolean __isset(string $name)

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

Parameters

string $name

Return Value

boolean

in Alvine at line 230
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 255
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 280
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 306
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 338
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 361
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 375
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 395
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 415
string getShortID(int|null $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 hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

Parameters

int|null $length

Return Value

string

in Alvine at line 441
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 462
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 474
__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 492
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 517
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

at line 124
__construct(string $table, string $name, integer $length = null, string $alias = null, string $comment = null)

Erstellt neues Feldobjekt

Parameters

string $table Tabelle
string $name Name des Feldes
integer $length Länge
string $alias Alias
string $comment Kommentar

Exceptions

StatementException

at line 148
Field setIdentifiersQuote($quoteChar)

Quote setzen, Standard ist ein Backtick für MySQL.

Parameters

$quoteChar

Return Value

Field

at line 158
string getTable()

Name der Tabelle

Return Value

string Tabelle

at line 167
string getName()

Name des Feldes

Return Value

string Name

at line 176
integer getType()

Typ des Feldes

Return Value

integer Type

at line 187
abstract integer getPDOType()

Wert für das Databindng

Return Value

integer

See also

http://php.net/manual/de/pdo.constants.php

at line 194
integer getLength()

Längenbeschränkung

Return Value

integer Länge oder -1, wenn keine Beschränkung vorliegt

at line 203
Field setRequire()

Feld ist ein Pflichtfeld

Return Value

Field Dieses Objekt

at line 213
Field unsetRequire()

Pflichtfeld ausschalten

Return Value

Field Dieses Objekt

at line 223
boolean isRequired()

Ist Feld ein Pflichtfeld

Return Value

boolean

at line 232
string|null getAlias()

Alias

Return Value

string|null

at line 241
string|null getPropertyName()

Name des Properties (entweder das Alias oder der Name des SQL-Feldes)

Return Value

string|null

at line 250
string|null getComment()

Kommentar

Return Value

string|null

at line 268
Field addReadHook(Closure $converter)

Callback, um Werte für die Speicherung umzustellen und in das Format des Storage-Provider zu bringen. Der Callback muss als Parameter einen Wert und als Rückgabewert ebenfalls einen Wert enthalten.

$obj->addReadHook(function($value) { return $value});

Parameters

Closure $converter Konverter

Return Value

Field Dieses Objekt

at line 288
Field addWriteHook(Closure $converter)

Callback, um Werte von der Speicherung umzustellen und in das Format des Models zu bringen. Der Callback muss als Parameter einen Wert und als Rückgabewert ebenfalls einen Wert enthalten.

$obj->addWriteHook(function($value) { return $value});

Parameters

Closure $converter Konverter

Return Value

Field Dieses Objekt

at line 302
mixed getPostProcessedData(mixed $value)

Konvertiert Wert die in der Datenbank stehen in das Zielformat. Die Methoden können mittels addReadHook an ein Feld gehängt werden.

Parameters

mixed $value Wert aus der Datenbank

Return Value

mixed Konvertierter Wert

at line 318
mixed getPreparedData(mixed $value)

Konvertiert Wert für die Datenbank, so das die Datenbank diese Versteht. Die Methoden können per addWriteHook angehängt werden.

Parameters

mixed $value Wert für die Datenbank

Return Value

mixed Konvertierter Wert

at line 330
string asString()

SQL-Statement als Zeichenkette ohne Alias

Return Value

string

at line 339
string asStringWithAlias()

SQL-Statement als Zeichenkette mit Alias ´A´

Return Value

string