FloatType
class FloatType extends Any 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
Traits
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. |
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
protected | $number |
Methods
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
Gespeicherte Zahl als Zeichenkette zurückgeben. Da die Zahl intern als Zeichenkette gespeichert ist, erfolgt kein Umwandlung.
Wird beim Setzen einer Eigenschaft aufgerufen. Wird auf die Eigenschaft float zugegriffen, so wird diese im Objekt verarbeitet, ansonsten im Alvine-Objekt als Eigenschaft.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
Je nach Name wird entweder der Float-Wert der Klasse, oder der Wert einer beliebigen Eigenschaft zurückgegeben.
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.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
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 gibt ein geklontes Objekt von sich selber zurück.
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.
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.
Neue Float anlegen.
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.
Prüfen ob Zahl NaN ist
Setzt der Wert des Floats, wenn der übergebene Wert größer als der gespeicherte Wert ist.
Setzt der Wert des Floats, wenn der übergebene Wert kleiner als der gespeicherte Wert ist.
Addiert eine neue Zahl zu dem Float hinzu und gibt ein neues Objekt zurück.
Subtrahiert eine Zahl von dem Float und gibt ein neues Objekt zurück.
Als Float
Als Zeichenkette
Gerichteter Vergleich von $this
mit $x
Details
in SerializableImplementation at line 122
string
serialize()
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.
in SerializableImplementation at line 193
bool
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 205
bool
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 228
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.
in SerializableImplementation at line 252
void
unserialize(string $serialized)
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
at line 139
string
__toString()
Gespeicherte Zahl als Zeichenkette zurückgeben. Da die Zahl intern als Zeichenkette gespeichert ist, erfolgt kein Umwandlung.
at line 94
void
__set(string $name, mixed $value)
Wird beim Setzen einer Eigenschaft aufgerufen. Wird auf die Eigenschaft float zugegriffen, so wird diese im Objekt verarbeitet, ansonsten im Alvine-Objekt als Eigenschaft.
in Alvine at line 222
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 231
__unset(string $name)
Zurücksetzen von Werten
at line 112
mixed
__get(string $name)
Je nach Name wird entweder der Float-Wert der Klasse, oder der Wert einer beliebigen Eigenschaft zurückgegeben.
in Alvine at line 281
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.
in Alvine at line 307
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;
}
in Alvine at line 339
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!
in Alvine at line 362
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();
}
in Alvine at line 376
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 396
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)
in Alvine at line 416
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.
at line 296
boolean
equals(Alvine $object)
Vergleich der Objekte
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
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();
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
at line 57
__construct(type $value)
Neue Float anlegen.
at line 78
static protected number
check(mixed $value)
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.
$i = '14a'; // ist 0 und nicht 14!
at line 150
bool
isNaN()
Prüfen ob Zahl NaN ist
at line 168
FloatType
max(number $newValue)
Setzt der Wert des Floats, wenn der übergebene Wert größer als der gespeicherte Wert ist.
$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
at line 187
FloatType
min(number $newValue)
Setzt der Wert des Floats, wenn der übergebene Wert kleiner als der gespeicherte Wert ist.
$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
at line 201
FloatType
add(number $summand)
Addiert eine neue Zahl zu dem Float hinzu und gibt ein neues Objekt zurück.
at line 216
FloatType
sub(number $subtrahend)
Subtrahiert eine Zahl von dem Float und gibt ein neues Objekt zurück.
at line 230
FloatType
round(integer $scale)
Runden
at line 248
float
asFloat(type $scale)
Als Float
at line 259
string
asString(type $scale)
Als Zeichenkette
at line 275
integer
compareTo(type $x)
Gerichteter Vergleich von $this
mit $x
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))