class Integer extends Any implements Comparable

Die Integer-Klasse von Alvine stellt eine objektorientierte Darstellung von Integerzahlen 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.

$integer = new \Alvine\Types\Integer(4);
$integer->integer='8.5';  // Inhalt setzen
echo $integer;  // Gibt folgendes aus: 8

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.

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected $integer

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

Gespeicherte Zahl als Zeichenkette zurückgeben.

void
__set(string $name, mixed $value)

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

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)

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

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

Vergleich der Objekte

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(integereger $value)

Neue Ganzzahl anlegen.

static integer
check(mixed $value)

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

static Integer
getMaximum()

Gibt den auf dem System größten Integerwert zurück.

static Integer
getMinimum()

Gibt den auf dem System kleinsten Integerwert zurück.

max(integer $newValue)

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

min(integer $newValue)

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

add(integer $summand)

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

sub(integer $subtrahend)

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

static integereger|Integer
validateRange(integereger|Integer $value, integereger $min, integereger $max)

Wertebereich überprüfen. Ist ein Wert außerhalb des Wertebereichs, so wird der Wert auf die Grenze, die er überschritten hat gesetzt.

integer
compareTo(type $x)

Gerichteter Vergleich von $this mit $x

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 143
string __toString()

Gespeicherte Zahl als Zeichenkette zurückgeben.

Return Value

string Daten des Objekts

at line 94
void __set(string $name, mixed $value)

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

Parameters

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

Return Value

void

See also

Alvine

in Alvine at line 223
boolean __isset(string $name)

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

Parameters

string $name

Return Value

boolean

in Alvine at line 232
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

at line 112
mixed __get(string $name)

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

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

See also

Alvine

in Alvine at line 282
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 308
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 340
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 363
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 377
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 397
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 416
string getShortID(integer $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 hilreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.

Parameters

integer $length Länge der ID

Return Value

string Hashwert des Objektes

at line 287
boolean equals(Alvine $object)

Vergleich der Objekte

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

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

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

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

Return Value

string Klassenname

See also

ClassType::getNormalizedName

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

Parameters

object $object

Return Value

boolean

at line 58
__construct(integereger $value)

Neue Ganzzahl anlegen.

Parameters

integereger $value Initialisierung der Zahl

at line 78
static protected integer check(mixed $value)

Diese interne Methode prüft den übergebenen Wert und wandelt diesen bei Bedarf in einen Integer 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!

Parameters

mixed $value zu prüfende Zahl

Return Value

integer überprüfter Wert

at line 125
static Integer getMaximum()

Gibt den auf dem System größten Integerwert zurück.

Return Value

Integer Maximaler Integerwert

at line 134
static Integer getMinimum()

Gibt den auf dem System kleinsten Integerwert zurück.

Return Value

Integer Minimaler Integerwert

at line 160
Integer max(integer $newValue)

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

$obj = new Integer(4);
$obj.max(3);   // Der Wert von $obj ist immer noch 4
$obj.max(6);   // Der Wert von $obj ist jetzt 6

Parameters

integer $newValue Neuer Wert

Return Value

Integer Referenz auf dieses Objekt

at line 179
Integer min(integer $newValue)

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

$obj = new Integer(4);
$obj.min(6);   // Der Wert von $obj ist immer noch 4
$obj.min(3);   // Der Wert von $obj ist jetzt 3

Parameters

integer $newValue Neuer Wert

Return Value

Integer Referenz auf dieses Objekt

at line 193
Integer add(integer $summand)

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

Parameters

integer $summand Wert der hinzugerechnet wird

Return Value

Integer Rechenergebnis

at line 207
Integer sub(integer $subtrahend)

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

Parameters

integer $subtrahend Wert der abgezogen wird

Return Value

Integer Rechenergebnis

at line 235
static integereger|Integer validateRange(integereger|Integer $value, integereger $min, integereger $max)

Wertebereich überprüfen. Ist ein Wert außerhalb des Wertebereichs, so wird der Wert auf die Grenze, die er überschritten hat gesetzt.

Wichtig: Wird ein Objekt übergeben, so wird der Wert des übergebenen Objektes gesetzt.

$i = 98;
echo Integer::validateRange($i,0,50); // 50
$integer = new Integer(12);
echo Integer::validateRange($integer,20,50)->integer; // 20
echo $integer->integer; // 20

Parameters

integereger|Integer $value Wert (dies kann entweder ein PHP-Integer oder eine Integer-Klasse sein.
integereger $min untere Grenze
integereger $max obere Grenze

Return Value

integereger|Integer überprüfter Wert

at line 267
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))

Parameters

type $x

Return Value

integer 0,1,-1