class Amount extends Alvine implements Measurable

Amount

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.

DOUBLE_RELATIVE_ERROR

pow(2, -53)

DECREMENT

DECREMENT

INCREMENT

INCREMENT

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected boolean $isExact
protected number $exactValue
protected number $minimum
protected number $maximum
protected Unit $unit

Methods

string
serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

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.

string
__toString()

Als formatierte 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 $that)

Vergleich mit

Alvine
getClone(boolean $deepClone = false)

Objekt klonen

__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
static Amount
valueOf(number $value, Unit $unit = null)

Wert

static Amount
valueOfInteger(integer $value, Unit $unit)

Integerwert

static Amount
valueOfFloat(float $value, Unit $unit)

Floatwert

bool
isExact()

Ist der Wert exakt?

getUnit()

Einheit

int
getExactValue()

Exakter Wert (Integer)

number
getEstimatedValue()

Geschätzter Wert

float
getMinimumValue()

Untere Grenze des Wertes

float
getMaximumValue()

Obere Grenze

float
getAbsoluteError()

Absoluter Fehler

float
getRelativeError()

Relativer Fehler

toIdentity(UnitConverter $cvtr, Unit $unit)

Identity

toRational(UnitConverter $cvtr, Unit $unit)

Rationaler Konverter

toDefault(UnitConverter $cvtr, Unit $unit)

Standard Konverter

to(Unit $unit)

Einheit umwandeln

opposite()

Gegenteil

plus(Amount $that)

Summe aus this und that

minus(Amount $that)

Differenz aus this und that

times(Amount|float|integer $factor)

Multiplikation mit Faktor

timesInteger(integer $factor)

Faktor

timesFloat(float $factor)

Miltiplikation mit Faktor

timesAmount(Amount $that)

Produkt

inverse()

1 / $this

divide(Amount $divisor)

Teiler

divideInteger(integer $divisor)

Teile durch Integer

divideFloat(float $divisor)

Teile durch Float

divideAmount(Amount $that)

Teile Klasse

abs()

Absolut

sqrt()

Quadratwurzel

root(number $n)

Wurzel

number
pow(type $exponent)

Potenz

integer
compareTo(Measurable $that)

Vergleich mit

number
approximates(Amount $that)

Näherung

bool
isLessThan(Amount $that)

Prüfen ob Wert kleiner ist als that

bool
isGreaterThan(Amount $that)

Prüfen ob Wert größer ist als that

bool
isLargerThan(Amount $that)

Prüfen ob Absoluter Wert größer ist als that

string
toText()

Als formatierte Zeichenkette

float
floatValue()

Float-Wert

int
integerValue()

Integer

copy()

Kopie des Objektes erstellen

number
normalizeValue(number $quantity)

Wert normalisieren

Details

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.

Return Value

string String-Repräsentation des Objektes

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

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

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.

Parameters

string $serialized

Return Value

void

at line 776
string __toString()

Als formatierte Zeichenkette

Return Value

string Daten des Objekts

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

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

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 256
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 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.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

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;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

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!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

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

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

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)

Return Value

string UUID des Objektes

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.

Parameters

int|null $length

Return Value

string

at line 703
boolean equals(Alvine $that)

Vergleich mit

Parameters

Alvine $that

Return Value

boolean true wenn beide Objekte identisch sind.

at line 906
Alvine getClone(boolean $deepClone = false)

Objekt klonen

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

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 101
static Amount valueOf(number $value, Unit $unit = null)

Wert

Parameters

number $value
Unit $unit

Return Value

Amount

Exceptions

InvalidArgumentException

at line 118
static protected Amount valueOfInteger(integer $value, Unit $unit)

Integerwert

Parameters

integer $value
Unit $unit

Return Value

Amount

at line 131
static protected Amount valueOfFloat(float $value, Unit $unit)

Floatwert

Parameters

float $value
Unit $unit

Return Value

Amount

at line 146
bool isExact()

Ist der Wert exakt?

Return Value

bool

at line 155
Unit getUnit()

Einheit

Return Value

Unit

at line 166
int getExactValue()

Exakter Wert (Integer)

Return Value

int

Exceptions

AmountException

at line 176
number getEstimatedValue()

Geschätzter Wert

Return Value

number

at line 185
float getMinimumValue()

Untere Grenze des Wertes

Return Value

float

at line 194
float getMaximumValue()

Obere Grenze

Return Value

float

at line 203
float getAbsoluteError()

Absoluter Fehler

Return Value

float

at line 212
float getRelativeError()

Relativer Fehler

Return Value

float

at line 224
protected Amount toIdentity(UnitConverter $cvtr, Unit $unit)

Identity

Parameters

UnitConverter $cvtr
Unit $unit

Return Value

Amount

at line 238
protected Amount toRational(UnitConverter $cvtr, Unit $unit)

Rationaler Konverter

Parameters

UnitConverter $cvtr
Unit $unit

Return Value

Amount

at line 252
protected Amount toDefault(UnitConverter $cvtr, Unit $unit)

Standard Konverter

Parameters

UnitConverter $cvtr
Unit $unit

Return Value

Amount

at line 271
Amount to(Unit $unit)

Einheit umwandeln

Parameters

Unit $unit

Return Value

Amount

at line 293
Amount opposite()

Gegenteil

Return Value

Amount

at line 323
Amount plus(Amount $that)

Summe aus this und that

Parameters

Amount $that

Return Value

Amount

at line 346
Amount minus(Amount $that)

Differenz aus this und that

Parameters

Amount $that

Return Value

Amount

at line 370
Amount times(Amount|float|integer $factor)

Multiplikation mit Faktor

Parameters

Amount|float|integer $factor

Return Value

Amount

at line 388
protected Amount timesInteger(integer $factor)

Faktor

Parameters

integer $factor

Return Value

Amount

at line 409
protected Amount timesFloat(float $factor)

Miltiplikation mit Faktor

Parameters

float $factor

Return Value

Amount

at line 426
protected Amount timesAmount(Amount $that)

Produkt

Parameters

Amount $that

Return Value

Amount

at line 480
Amount inverse()

1 / $this

Return Value

Amount

at line 509
Amount divide(Amount $divisor)

Teiler

Parameters

Amount $divisor

Return Value

Amount

Exceptions

InvalidArgumentException

at line 527
protected Amount divideInteger(integer $divisor)

Teile durch Integer

Parameters

integer $divisor

Return Value

Amount

at line 549
protected Amount divideFloat(float $divisor)

Teile durch Float

Parameters

float $divisor

Return Value

Amount

at line 566
protected Amount divideAmount(Amount $that)

Teile Klasse

Parameters

Amount $that

Return Value

Amount

at line 580
Amount abs()

Absolut

Return Value

Amount

at line 593
Amount sqrt()

Quadratwurzel

Return Value

Amount

at line 617
Amount root(number $n)

Wurzel

Parameters

number $n

Return Value

Amount

Exceptions

ArithmeticException

at line 660
number pow(type $exponent)

Potenz

Parameters

type $exponent

Return Value

number

at line 685
integer compareTo(Measurable $that)

Vergleich mit

Parameters

Measurable $that

Return Value

integer 0,1,-1

at line 724
number approximates(Amount $that)

Näherung

```this ≅ $that

Parameters

Amount $that

Return Value

number

at line 736
bool isLessThan(Amount $that)

Prüfen ob Wert kleiner ist als that

Parameters

Amount $that

Return Value

bool

at line 747
bool isGreaterThan(Amount $that)

Prüfen ob Wert größer ist als that

Parameters

Amount $that

Return Value

bool

at line 758
bool isLargerThan(Amount $that)

Prüfen ob Absoluter Wert größer ist als that

Parameters

Amount $that

Return Value

bool

at line 767
string toText()

Als formatierte Zeichenkette

Return Value

string

at line 785
float floatValue()

Float-Wert

Return Value

float

at line 796
int integerValue()

Integer

Return Value

int

Exceptions

AmountException

at line 890
Amount copy()

Kopie des Objektes erstellen

Return Value

Amount

at line 929
protected number normalizeValue(number $quantity)

Wert normalisieren

Parameters

number $quantity

Return Value

number