Documentation

MYR extends Currency
in package

Alvine

Measure

Economics

Currency

Währung Malaysian Ringgit

Constants

APIVERSION = 1: Version der API-Version der Klasse.
DEFAULT_CURRENCY_SIGN = '¤': Standard-Währungssymbol
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

$baseUnit : BaseUnit
$baseUnits : Map<string|int, Unit>
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$properties : array
$toBaseUnit : CurrencyConverter

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: Währung MYR erstellen
__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() : string: Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
alternate() : AlternateUnit: Einheit auf anderes Symbol ändern
compound() : CompoundUnit: Zusammengefasste Einheit erstellen
divide() : Unit: Teilen
equals() : boolean: Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von `Alvine::getID()` zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
getBaseUnit() : BaseUnit|null: Basiseinheit holen, wenn keine Basiseinheit gefunden wird, so wird null zurückgegeben.
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.
getCode() : string: Code
getConverterTo() : UnitConverter: Konverter für diese Einheit holen
getDefaultFractionDigits() : int: Anzahl der Stellen
getDimension() : Dimension: Dimension der Einheit holen
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.
getOne() : ProductUnit: Einheit One zurückgeben
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.
getStandardUnit() : Unit: Standardeinheit
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
inverse() : Unit: Invertieren
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).
isCompatible() : boolean: Prüfen ob die Größen zu einer Dimension gehören
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.
isStandardUnit() : boolean: Prüfen ob Standardeinheit ist
plus() : TransformedUnit: Wert hinzufügen
pow() : Unit: Potenz
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
root() : Unit: Root
setBaseUnit() : void: Basiseinheit setzen
times() : TransformedUnit: Multiplizieren
toStandardUnit() : UnitConverter: Umwandeln
transform() : Unit
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
initBaseUnits() : void: Map für Basiseinheiten initialisieren
getBaseUnits() : BaseUnit: Basiseinheiten
transformOf() : UnitConverter: Transformation

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

DEFAULT_CURRENCY_SIGN

Standard-Währungssymbol


    public
        mixed
    DEFAULT_CURRENCY_SIGN
    = '¤'

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

$baseUnit


    protected
    static    BaseUnit
    $baseUnit

$baseUnits


    protected
    static    Map<string|int, Unit>
    $baseUnits

Zentrale Liste mit allen definierten Basiseinheiten

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

$properties


    protected
        array
    $properties
     = []

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

$toBaseUnit


    protected
        CurrencyConverter
    $toBaseUnit

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

Währung MYR erstellen


    public
                    __construct() : mixed

__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

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

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette


    public
                    __toString() : string

echo (string) new MyObect();

Return values

string —

Daten 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

alternate()

Einheit auf anderes Symbol ändern


    public
        final            alternate(string $symbol) : AlternateUnit

Parameters

$symbol : string

Return values

AlternateUnit

compound()

Zusammengefasste Einheit erstellen


    public
        final            compound(Unit $subunit) : CompoundUnit

Parameters

$subunit : Unit

Return values

CompoundUnit

divide()


    public
        final            divide(integer $divisor) : Unit

Parameters

$divisor : integer

Return values

Unit

equals()

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von `Alvine::getID()` zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.


    public
                    equals(Alvine $object) : boolean

class MyObject extends Alvine };

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}

Parameters

$object : Alvine: Objekt das überprüft werden soll

Return values

boolean —

true wenn beide Objekte identisch sind.

getBaseUnit()

Basiseinheit holen, wenn keine Basiseinheit gefunden wird, so wird null zurückgegeben.


    public
            static        getBaseUnit(string $symbol) : BaseUnit|null

Parameters

$symbol : string

Return values

BaseUnit|null

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

getCode()

Code


    public
                    getCode() : string

Return values

string

getConverterTo()

Konverter für diese Einheit holen


    public
        final            getConverterTo(Unit $that) : UnitConverter

Parameters

$that : Unit

Return values

UnitConverter

getDefaultFractionDigits()

Anzahl der Stellen


    public
                    getDefaultFractionDigits() : int

Return values

int

getDimension()

Dimension der Einheit holen


    public
                    getDimension() : Dimension

Eine Dimension ist eine Art Zusammenfassung mehrerer Einheiten zu einem System.

Return values

Dimension

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

getOne()

Einheit One zurückgeben


    public
            static        getOne() : ProductUnit

Return values

ProductUnit

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

getStandardUnit()

Standardeinheit


    public
    abstract                getStandardUnit() : Unit

Return values

Unit

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

inverse()

Invertieren


    public
        final            inverse() : Unit

Return values

Unit

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

isCompatible()

Prüfen ob die Größen zu einer Dimension gehören


    public
        final            isCompatible(Unit $that) : boolean

Parameters

$that : Unit

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

isStandardUnit()

Prüfen ob Standardeinheit ist


    public
                    isStandardUnit() : boolean

Return values

boolean

plus()

Wert hinzufügen


    public
        final            plus(number $offset) : TransformedUnit

Parameters

$offset : number

Return values

TransformedUnit

pow()

Potenz


    public
        final            pow(integer $n) : Unit

Parameters

$n : integer

Return values

Unit

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

root()

Root


    public
        final            root(integer $n) : Unit

Parameters

$n : integer

Return values

Unit

setBaseUnit()

Basiseinheit setzen


    public
            static        setBaseUnit(string $symbol, Unit $unit) : void

Parameters

$symbol : string
$unit : Unit

times()

Multiplizieren


    public
        final            times(Unit $factor) : TransformedUnit

Parameters

$factor : Unit

Return values

TransformedUnit

toStandardUnit()

Umwandeln


    public
    abstract                toStandardUnit() : UnitConverter

Return values

UnitConverter

transform()


    public
                    transform(UnitConverter $operation) : Unit

Parameters

$operation : UnitConverter

Return values

Unit

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>

initBaseUnits()

Map für Basiseinheiten initialisieren


    protected
            static        initBaseUnits() : void

getBaseUnits()

Basiseinheiten


    private
                    getBaseUnits() : BaseUnit

Return values

BaseUnit

transformOf()

Transformation


    private
                    transformOf(Unit $baseUnit) : UnitConverter

Parameters

$baseUnit : Unit

Return values

UnitConverter

MYR extends Currency in package Alvine Measure Economics Currency

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

DEFAULT_CURRENCY_SIGN

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$baseUnit

$baseUnits

$hasAssociatedProperties

$hash

$hasVolatileProperties

$properties

$toBaseUnit

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

alternate()

Parameters

Return values

compound()

Parameters

Return values

divide()

Parameters

Return values

equals()

Parameters

Return values

getBaseUnit()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getCode()

Return values

getConverterTo()

Parameters

Tags

Return values

getDefaultFractionDigits()

MYR extends Currency
in package

Alvine

Measure

Economics

Currency