Documentation

ValidationReport extends Alvine
in package

Alvine

Data

Der ValidationReport fasst die Ergebnisse der Prüfung eines Objektmodells zusammen.

Tritt bei einem Feldwet ein Fehler auf, so kann dieser Fehler mittels ValidationReport::setError($fieldName) oder ValidationReport::setWarning($fieldName) gesetzt werden. Erweiterte Fehlermeldungen können mittels ValidationReport::setMessage($fieldName, $message) gesetzt werden.

Will eine Anwendung prüfen, ob ein Fehler aufgetreten ist, so kann es dies mit der Methode ValidationReport::isValid() überprüfen.

Constants

APIVERSION = 1: Version der API-Version der Klasse.
ERROR = 'error': Fehlertype
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
MESSAGE = 'message': Meldung
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.
STATE = 'state': Status
VALID = 'valid': Warnung
VERSION = 2: Generelle Alvine-Version
WARNING = 'warn': Warnung

Properties

$errors : SimpleMap
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$messages : SimpleMap
$properties : array
$warnings : SimpleMap

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.
__construct() : mixed: Neues Objekt
__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.
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.
getMessage() : string|null: Fehlermeldung einer Eigenschaft zurückgeben.
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
hasError() : ValidationReport: Sind im Report Fehler definiert, liefert diese Methode true zurück
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
hasWarning() : boolean: Sind im Report Warnung definiert, liefert diese Methode true zurück
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.
isValid() : ValidationReport: Gibt true zurück, wenn ein Fehler, eine Warnung oder eine Meldung im Report gesetzt wurde
merge() : ValidationReport: Zusammenfassen von ValidationReports
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
reset() : ValidationReport: Werte zurück setzten
setError() : ValidationReport: Fehlermodus einer Eigenschaft setzen
setMessage() : ValidationReport: Fehlermeldung für eine Eigenschaft setzen
setWarning() : ValidationReport: Warnung einer Eigenschaft setzen
toArray() : array<string|int, name>: Bericht als Array
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

ERROR

Fehlertype


    public
        mixed
    ERROR
    = 'error'

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

MESSAGE

Meldung


    public
        mixed
    MESSAGE
    = 'message'

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.


    public
        mixed
    SERIALVERSION
    = 1

https://php.watch/versions/8.1/serializable-deprecated

STATE

Status


    public
        mixed
    STATE
    = 'state'

VALID

Warnung


    public
        mixed
    VALID
    = 'valid'

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

WARNING

Warnung


    public
        mixed
    WARNING
    = 'warn'

$errors


    protected
        SimpleMap
    $errors

Fehler je Eigenschaft

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$hash

Eindeutige ID


    protected
        string
    $hash
     = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$messages


    protected
        SimpleMap
    $messages

Fehler je Feld

$properties


    protected
        array
    $properties
     = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

$warnings


    protected
        SimpleMap
    $warnings

Warnungen

__call()

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


    public
                    __call(string $name, array $arguments) : mixed

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

$name : string: Funktionsname
$arguments : array: Argumente

Return values

mixed —

Ergebnis des Callbacks

__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.


    public
                    __clone() : mixed

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

__construct()

Neues Objekt


    public
                    __construct() : mixed

__get()

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.


    public
                    __get(string $name) : mixed

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

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

Parameters

$name : string: Name der Eigenschaft

Return values

mixed —

Wert der Eigenschaft

__isset()

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


    public
                    __isset(string $name) : boolean

Parameters

$name : string

Return values

boolean

__serialize()

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


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

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Return values

array<string|int, mixed>

__set()

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


    public
                    __set(string $name, mixed $value) : void

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

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

Return values

void

__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette


    public
                    __toString() : string

echo (string) new MyObect();

Return values

string —

Daten des Objekts

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

equals()

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.


    public
                    equals(Alvine $object) : boolean

class MyObject extends Alvine };

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

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

Parameters

$object : Alvine: Objekt das überprüft werden soll

Return values

boolean —

true wenn beide Objekte identisch sind.

getClass()

Name der Klasse


    public
                    getClass() : string

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

echo $obj->getClass();

Return values

string —

Klassenname

getClone()

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


    public
                    getClone([boolean $deepClone = false ]) : Alvine

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

$deepClone : boolean = false: Clone aller enthaltenen Objekte

Return values

Alvine

getClosure()

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.


    public
                    getClosure(string $name) : Closure

Parameters

$name : string: Name des Closure

Return values

Closure

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

Return values

string —

Hashwert des Objektes

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.


    public
                    getID() : string

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 values

string —

UUID des Objektes

getMessage()

Fehlermeldung einer Eigenschaft zurückgeben.


    public
                    getMessage(string $name) : string|null

Es kann Meldungen auch für Felder ohne Fehler oder Warnung geben.

Parameters

$name : string: Name der Eigenschaft

Return values

string|null —

Meldung

getShortID()

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.


    public
                    getShortID([int|null $length = null ]) : string

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

$length : int|null = null

Return values

string

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasError()

Sind im Report Fehler definiert, liefert diese Methode true zurück


    public
                    hasError(string $name) : ValidationReport

Parameters

$name : string: Name der Eigenschaft

Return values

ValidationReport

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

hasWarning()

Sind im Report Warnung definiert, liefert diese Methode true zurück


    public
                    hasWarning(string $name) : boolean

Parameters

$name : string: Name der Eigenschaft

Return values

boolean

isCallable()

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


    public
                    isCallable(string $name) : bool

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

Parameters

$name : string: Name der Methode

Return values

bool —

Ergebnis

isInstanceOf()

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.


    public
                    isInstanceOf(object $object) : boolean

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

Die Prüfung entspricht

$this instanceof $object

Parameters

$object : object

Return values

boolean

isValid()

Gibt true zurück, wenn ein Fehler, eine Warnung oder eine Meldung im Report gesetzt wurde


    public
                    isValid() : ValidationReport

Return values

ValidationReport

merge()

Zusammenfassen von ValidationReports


    public
                    merge(ValidationReport $validationReport) : ValidationReport

Parameters

$validationReport : ValidationReport

Return values

ValidationReport

propertyExists()

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


    public
                    propertyExists(string $name) : boolean

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

Parameters

$name : string: Name der Eigenschaft

Return values

boolean

reset()

Werte zurück setzten


    public
                    reset(string $name) : ValidationReport

Parameters

$name : string

Return values

ValidationReport

setError()

Fehlermodus einer Eigenschaft setzen


    public
                    setError(string $name[, boolean $mode = true ]) : ValidationReport

Parameters

$name : string: Name der Eigenschaft
$mode : boolean = true: Fehler einschalten (true) oder ausschalten (false)

Return values

ValidationReport

setMessage()

Fehlermeldung für eine Eigenschaft setzen


    public
                    setMessage(string $name, string $message) : ValidationReport

Parameters

$name : string: Name der Eigenschaft
$message : string: Meldung

Return values

ValidationReport

setWarning()

Warnung einer Eigenschaft setzen


    public
                    setWarning(string $name[, boolean $mode = true ]) : ValidationReport

Parameters

$name : string: Name der Eigenschaft
$mode : boolean = true: Warnung einschalten (true) oder ausschalten (false)

Return values

ValidationReport

toArray()

Bericht als Array


    public
                    toArray() : array<string|int, name>

[Feldname][valid] true/false [Feldname][state] Status (error, warning) [Feldname][message] Freitext

Return values

array<string|int, name>

checkAndAdjustSerialisation()

Dealing with versions


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

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters

$serialization : array: Daten des serialisiertes Objekts

Return values

array<string|int, mixed>

ValidationReport extends Alvine in package Alvine Data

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

ERROR

IDENTIFICATION

MESSAGE

SERIALVERSION

STATE

VALID

VERSION

WARNING

Properties

$errors

$hasAssociatedProperties

$hash

$hasVolatileProperties

$messages

$properties

$warnings

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

equals()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getHashCode()

Tags

Return values

getID()

Return values

getMessage()

Parameters

Return values

getShortID()

Parameters

Return values

hasAssociatedProperties()

Tags

Return values

hasError()

ValidationReport extends Alvine
in package

Alvine

Data