Documentation

FloatType extends Any
in package

Alvine

Types

implements Comparable

Die Float-Klasse von Alvine stellt eine objektorientierte Darstellung von Floats zur Verfügung. Der Wert des Objektes lässt sich über die Methoden ändern und ist nicht schreibgeschützt.

Für die Berechnung der Werte wird die PHP-Erweiterung bcmath verwendet.

$float = new \Alvine\Types\Float(4);
$float->number='8.5';  // Inhalt setzen
echo $float;  // Gibt folgendes aus: 8.5

Interfaces

Comparable: Dieses Interface implementiert `Comparable->compareTo()`, das anders als `Alvine->euals()` ein gerichteten Vergleich durchführt.

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
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.
VERSION = 2: Generelle Alvine-Version

Properties

$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$number : mixed
$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.
__construct() : mixed: Neue Float anlegen.
__get() : mixed: Je nach Name wird entweder der Float-Wert der Klasse, oder der Wert einer beliebigen Eigenschaft zurückgegeben.
__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: Wird beim Setzen einer Eigenschaft aufgerufen. Wird auf die Eigenschaft float zugegriffen, so wird diese im Objekt verarbeitet, ansonsten im Alvine-Objekt als Eigenschaft.
__toString() : string: Gespeicherte Zahl als Zeichenkette zurückgeben. Da die Zahl intern als Zeichenkette gespeichert ist, erfolgt kein Umwandlung.
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
add() : FloatType: Addiert eine neue Zahl zu dem Float hinzu und gibt ein neues Objekt zurück.
asFloat() : float: Als Float
asString() : string: Als Zeichenkette
compareTo() : integer: Gerichteter Vergleich von `$this` mit `$x`
equals() : boolean: Vergleich der Objekte
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.
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.
isNaN() : boolean: Prüfen ob Zahl NaN ist
max() : FloatType: Setzt der Wert des Floats, wenn der übergebene Wert größer als der gespeicherte Wert ist.
min() : FloatType: Setzt der Wert des Floats, wenn der übergebene Wert kleiner als der gespeicherte Wert ist.
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
round() : Float: Runden
sub() : FloatType: Subtrahiert eine Zahl von dem Float und gibt ein neues Objekt zurück.
check() : number: Diese interne Methode prüft den übergebenen Wert und wandelt diesen bei Bedarf in eine Float-Zahl um. Sollte es sich bei dem Wert um keinen gültigen Wert handeln, so wird eine Null "0" zurück gegeben.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
getMaxScale() : integer: Länge der Nachkommastellen ermitteln

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

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

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

$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)

$number


    protected
        mixed
    $number
     = '0'

$properties


    protected
        array
    $properties
     = []

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

__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()

Neue Float anlegen.


    public
                    __construct(type $value) : mixed

Parameters

$value : type: Initialisierung der Zahl

__get()

Je nach Name wird entweder der Float-Wert der Klasse, oder der Wert einer beliebigen Eigenschaft zurückgegeben.


    public
                    __get(string $name) : mixed

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()

Wird beim Setzen einer Eigenschaft aufgerufen. Wird auf die Eigenschaft float zugegriffen, so wird diese im Objekt verarbeitet, ansonsten im Alvine-Objekt als Eigenschaft.


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

Parameters

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

__toString()

Gespeicherte Zahl als Zeichenkette zurückgeben. Da die Zahl intern als Zeichenkette gespeichert ist, erfolgt kein Umwandlung.


    public
                    __toString() : string

Return values

string —

Zeichenkette 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

add()

Addiert eine neue Zahl zu dem Float hinzu und gibt ein neues Objekt zurück.


    public
                    add(number $summand) : FloatType

Parameters

$summand : number: Wert der hinzugerechnet wird

Return values

FloatType —

Rechenergebnis

asFloat()

Als Float


    public
                    asFloat(type $scale) : float

Parameters

$scale : type

Return values

float

asString()

Als Zeichenkette


    public
                    asString(type $scale) : string

Parameters

$scale : type

Return values

string

compareTo()

Gerichteter Vergleich von `$this` mit `$x`


    public
                    compareTo(type $x) : integer

Gibt 0 zurück, wenn das Objekt und der Parameter identisch sind. 1 wenn das Objekt größer ist und -1, wenn das Objekt kleiner ist.

Es sollte folgendes gelten (x.compareTo(y)==0) == (x.equals(y))

Parameters

$x : type

Return values

integer —

0, 1, -1

equals()

Vergleich der Objekte


    public
                    equals(Alvine $object) : boolean

Parameters

$object : Alvine

Return values

boolean

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

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

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

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

isNaN()

Prüfen ob Zahl NaN ist


    public
                    isNaN() : boolean

Return values

boolean

max()

Setzt der Wert des Floats, wenn der übergebene Wert größer als der gespeicherte Wert ist.


    public
                    max(number $newValue) : FloatType

$obj = new Float(4.0);
$obj.max(3.4);   // Der Wert von $obj ist immer noch 4.0
$obj.max(6.3);   // Der Wert von $obj ist jetzt 6.3

Parameters

$newValue : number: Neuer Wert

Return values

FloatType —

Referenz auf dieses Objekt

min()

Setzt der Wert des Floats, wenn der übergebene Wert kleiner als der gespeicherte Wert ist.


    public
                    min(number $newValue) : FloatType

$obj = new Integer(4.3);
$obj.min(6.2);   // Der Wert von $obj ist immer noch 4.3
$obj.min(3.6);   // Der Wert von $obj ist jetzt 3.6

Parameters

$newValue : number: Neuer Wert

Return values

FloatType —

Referenz auf dieses Objekt

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

round()

Runden


    public
                    round(integer $scale) : Float

Parameters

$scale : integer

Return values

Float

sub()

Subtrahiert eine Zahl von dem Float und gibt ein neues Objekt zurück.


    public
                    sub(number $subtrahend) : FloatType

Parameters

$subtrahend : number: Wert der abgezogen wird

Return values

FloatType

check()

Diese interne Methode prüft den übergebenen Wert und wandelt diesen bei Bedarf in eine Float-Zahl um. Sollte es sich bei dem Wert um keinen gültigen Wert handeln, so wird eine Null "0" zurück gegeben.


    protected
            static        check(mixed $value) : number

$i = '14a'; // ist 0 und nicht 14!

Parameters

$value : mixed: zu prüfende Zahl

Return values

number —

überprüfter Wert

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>

getMaxScale()

Länge der Nachkommastellen ermitteln


    private
                    getMaxScale(float $value) : integer

Parameters

$value : float

Return values

integer

FloatType extends Any in package Alvine Types implements Comparable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$hasAssociatedProperties

$hash

$hasVolatileProperties

$number

$properties

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Tags

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

add()

Parameters

Return values

asFloat()

Parameters

Return values

asString()

Parameters

Return values

compareTo()

Parameters

Return values

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

getShortID()

Parameters

Return values

FloatType extends Any
in package

Alvine

Types

implements Comparable