Documentation

Amount extends Alvine
in package
implements Measurable

Amount

Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine
since
20170506

Table of Contents

Interfaces

Measurable
Interface für Meßwerte

Constants

APIVERSION  = 1
Version der API-Version der Klasse.
DECREMENT  = 1.0 - \Alvine\Measure\Amount::DOUBLE_RELATIVE_ERROR
DECREMENT
DOUBLE_RELATIVE_ERROR  = 1.1102230246252E-16
pow(2, -53)
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
INCREMENT  = \Alvine\Measure\Amount::DOUBLE_RELATIVE_ERROR + 1
INCREMENT
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

$exactValue  : number
$hasAssociatedProperties  : boolean
$hash  : string
Eindeutige ID
$hasVolatileProperties  : boolean
$isExact  : boolean
$maximum  : number
$minimum  : number
$properties  : array
$unit  : Unit

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.
__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()  : atring
Als formatierte Zeichenkette
__unserialize()  : void
__unset()  : mixed
Zurücksetzen von Werten
abs()  : Amount
Absolut
approximates()  : number
Näherung
compareTo()  : integer
Vergleich mit
copy()  : Amount
Kopie des Objektes erstellen
divide()  : Amount
Teiler
equals()  : boolean
Vergleich mit
floatValue()  : float
Float-Wert
getAbsoluteError()  : float
Absoluter Fehler
getClass()  : string
Name der Klasse
getClone()  : Amount
Objekt klonen
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.
getEstimatedValue()  : number
Geschätzter Wert
getExactValue()  : integer
Exakter Wert (Integer)
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.
getMaximumValue()  : float
Obere Grenze
getMinimumValue()  : float
Untere Grenze des Wertes
getRelativeError()  : float
Relativer Fehler
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.
getUnit()  : Unit
Einheit
hasAssociatedProperties()  : boolean
Check if the object has associative properties
hasVolatileProperties()  : boolean
Prüfen ob das Objekt volatile Eigenschaften besitzt
integerValue()  : integer
Integer
inverse()  : Amount
1 / $this
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).
isExact()  : boolean
Ist der Wert exakt?
isGreaterThan()  : boolean
Prüfen ob Wert größer ist als that
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.
isLargerThan()  : boolean
Prüfen ob Absoluter Wert größer ist als that
isLessThan()  : boolean
Prüfen ob Wert kleiner ist als that
minus()  : Amount
Differenz aus this und that
opposite()  : Amount
Gegenteil
plus()  : Amount
Summe aus this und that
pow()  : number
Potenz
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
root()  : Amount
Wurzel
sqrt()  : Amount
Quadratwurzel
times()  : Amount
Multiplikation mit Faktor
to()  : Amount
Einheit umwandeln
toText()  : atring
Als formatierte Zeichenkette
valueOf()  : Amount
Wert
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
divideAmount()  : Amount
Teile Klasse
divideFloat()  : Amount
Teile durch Float
divideInteger()  : Amount
Teile durch Integer
normalizeValue()  : number
Wert normalisieren
timesAmount()  : Amount
Produkt
timesFloat()  : Amount
Miltiplikation mit Faktor
timesInteger()  : Amount
Faktor
toDefault()  : Amount
Standard Konverter
toIdentity()  : Amount
Identity
toRational()  : Amount
Rationaler Konverter
valueOfFloat()  : Amount
Floatwert
valueOfInteger()  : Amount
Integerwert
__construct()  : mixed
calculateConverterOf()  : UnitConverter
calculateInverseOf()  : Unit
Inverses Objekt
calculateProductOf()  : ProductUnit
Calculate Product Of
converterOf()  : Converter
Konverter
inverseOf()  : Unit
Inverse Of
newInstance()  : Amount
productOf()  : ProductUnit
Product Of
setExact()  : Amount
Wert setzen
uRShift()  : number
Rechtsshift

Constants

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

DECREMENT

DECREMENT

public mixed DECREMENT = 1.0 - \Alvine\Measure\Amount::DOUBLE_RELATIVE_ERROR

DOUBLE_RELATIVE_ERROR

pow(2, -53)

public mixed DOUBLE_RELATIVE_ERROR = 1.1102230246252E-16

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

INCREMENT

INCREMENT

public mixed INCREMENT = \Alvine\Measure\Amount::DOUBLE_RELATIVE_ERROR + 1

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

Properties

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

$properties

protected array $properties = []

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

Methods

__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

Tags
throws
NotCallableException

Exception

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.

__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

Tags
throws
BadPropertyException
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.

Tags
see
https://php.watch/versions/8.1/serializable-deprecated
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()

Als formatierte Zeichenkette

public __toString() : atring
Return values
atring

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

approximates()

Näherung

public approximates(Amount $that) : number
Parameters
$that : Amount
Return values
number

floatValue()

Float-Wert

public floatValue() : float
Return values
float

getAbsoluteError()

Absoluter Fehler

public getAbsoluteError() : float
Return values
float

getClass()

Name der Klasse

public getClass() : string 
class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();
Tags
see
ClassType::getNormalizedName
Return values
string —

Klassenname

getClone()

Objekt klonen

public getClone([boolean $deepClone = false ]) : Amount
Parameters
$deepClone : boolean = false
Return values
Amount

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

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getEstimatedValue()

Geschätzter Wert

public getEstimatedValue() : number
Return values
number

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
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

getMaximumValue()

Obere Grenze

public getMaximumValue() : float
Return values
float

getMinimumValue()

Untere Grenze des Wertes

public getMinimumValue() : float
Return values
float

getRelativeError()

Relativer Fehler

public getRelativeError() : float
Return values
float

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

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

isExact()

Ist der Wert exakt?

public isExact() : boolean
Return values
boolean

isGreaterThan()

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

public isGreaterThan(Amount $that) : boolean
Parameters
$that : Amount
Return values
boolean

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

isLargerThan()

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

public isLargerThan(Amount $that) : boolean
Parameters
$that : Amount
Return values
boolean

isLessThan()

Prüfen ob Wert kleiner ist als that

public isLessThan(Amount $that) : boolean
Parameters
$that : Amount
Return values
boolean

pow()

Potenz

public pow(type $exponent) : number
Parameters
$exponent : type
Return values
number

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

toText()

Als formatierte Zeichenkette

public toText() : atring
Return values
atring

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

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed>

divideFloat()

Teile durch Float

protected divideFloat(float $divisor) : Amount
Parameters
$divisor : float
Return values
Amount

divideInteger()

Teile durch Integer

protected divideInteger(integer $divisor) : Amount
Parameters
$divisor : integer
Return values
Amount

normalizeValue()

Wert normalisieren

protected normalizeValue(number $quantity) : number
Parameters
$quantity : number
Return values
number

timesFloat()

Miltiplikation mit Faktor

protected timesFloat(float $factor) : Amount
Parameters
$factor : float
Return values
Amount

timesInteger()

Faktor

protected timesInteger(integer $factor) : Amount
Parameters
$factor : integer
Return values
Amount

valueOfInteger()

Integerwert

protected static valueOfInteger(integer $value, Unit $unit) : Amount
Parameters
$value : integer
$unit : Unit
Return values
Amount

calculateProductOf()

Calculate Product Of

private static calculateProductOf(Unit $left, Unit $right) : ProductUnit
Parameters
$left : Unit
$right : Unit
Return values
ProductUnit

converterOf()

Konverter

private static converterOf(Unit $left, Unit $right) : Converter
Parameters
$left : Unit
$right : Unit
Return values
Converter

productOf()

Product Of

private static productOf(Unit $left, Unit $right) : ProductUnit
Parameters
$left : Unit
$right : Unit
Return values
ProductUnit

setExact()

Wert setzen

private setExact(number $exactValue) : Amount
Parameters
$exactValue : number
Return values
Amount

uRShift()

Rechtsshift

private uRShift(number $a, number $b) : number
Parameters
$a : number
$b : number
Return values
number 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results