SI
class SI extends SystemOfUnits
Diese Klasse stellt Konstanten für Umrechnung und Symbol der SI-Einheiten zur Verfügung.
Außerdem werden eindeutige Namen für die einzelnen SI-Einheiten vergeben.
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. |
METER |
Meter |
METRE |
Meter |
KELVIN |
thermodynamische measureeratur |
KILOGRAM |
Gewicht Kilogramm |
SECOND |
Zeit Sekunde |
AMPERE |
elektrische Stromstärke, Ampère |
MOLE |
Substanzmenge mol |
CANDELA |
Lichtstärke Candela cd |
LUX |
|
LUMEN |
|
MILLIMETER |
|
KILOMETER |
|
CENTIMETER |
|
CUBICMETER |
|
CUBICMETRE |
|
SQUAREMETER |
|
METERPERSECOND |
|
GRAM |
|
OHM |
|
CELSIUS |
|
HERTZ |
|
NEWTON |
|
RADIAN |
|
PASCAL |
|
JOULE |
|
WATT |
|
COULOMB |
|
VOLT |
|
FARAD |
|
STERADIAN |
|
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
static protected array | $instances | from SingletonImplementation | |
static protected Unit | $units | from SystemOfUnits |
Methods
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.
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
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.
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 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.
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.
Ampere
Lichtstärke
Temperatur
Stoffmenge
Gramm
Radian
Steradian
Hertz
Newton
Pascal
Joule
Watt
Kapazität
Spannung (Volt)
Farad
Widerstand
Temperatur (Celsius)
Geschwindigkeit
Quadratmeter
Kubikmeter
Kilometer
Centimeter
Millimeter
Lumen
Lux
Details
in SerializableImplementation at line 126
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.
in SerializableImplementation at line 198
boolean
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 210
boolean
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 233
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 256
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.
in Alvine at line 178
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
in Alvine at line 212
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;
in Alvine at line 223
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 232
__unset(string $name)
Zurücksetzen von Werten
in Alvine at line 257
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;
}
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.
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;
}
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!
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();
}
in Alvine at line 377
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
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)
in Alvine at line 417
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.
in Alvine at line 443
boolean
equals(Alvine $object)
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.
class MyObject extends Alvine {};
$objA = new MyObject();
$objB = new MyObject();
if($objA->equals($objB)) {
// ...
}
in Alvine at line 464
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 476
__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 494
string
getClass()
Name der Klasse
class MyObject extends Alvine {};
$obj = new MyObject();
echo $obj->getClass();
in Alvine at line 519
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
in SingletonImplementation at line 65
static object
getInstance()
Instanz erstellen
Erstellt ein neues Objekt. Ist bereits ein Objekt registriert, so wird dieser zurückgegeben.
in Singleton at line 42
protected
__construct()
Von der Singleton-Klasse kann keine Instanz direkt erstellt werden.
in SystemOfUnits at line 51
static class
getOrCreateUnit(string $symbol, string|closure $class)
Erstellen von eindeutigen Einheiten
in SystemOfUnits at line 79
static
getUnit(string $symbol)
at line 190
static ElectricCurrent
ampere()
Ampere
at line 199
static LuminousIntensity
candela()
Lichtstärke
at line 208
static Temperature
kelvin()
Temperatur
at line 217
static Mass
kilogram()
Masse
at line 226
static AmountOfSubstance
mole()
Stoffmenge
at line 235
static Length
meter()
Länge
at line 244
static Length
metre()
Alias für meter()
at line 253
static Duration
second()
Zeit
at line 262
static TransformedUnit
gram()
Gramm
at line 273
static AlternateUnit
radian()
Radian
at line 284
static AlternateUnit
steradian()
Steradian
at line 295
static AlternateUnit
hertz()
Hertz
at line 306
static AlternateUnit
newton()
Newton
at line 317
static AlternateUnit
pascal()
Pascal
at line 328
static AlternateUnit
joule()
Joule
at line 339
static AlternateUnit
watt()
Watt
at line 350
static AlternateUnit
coulomb()
Kapazität
at line 361
static AlternateUnit
volt()
Spannung (Volt)
at line 372
static AlternateUnit
farad()
Farad
at line 383
static AlternateUnit
ohm()
Widerstand
at line 394
static AlternateUnit
celsius()
Temperatur (Celsius)
at line 405
static ProductUnit
meterPerSecond()
Geschwindigkeit
at line 416
static ProductUnit
squareMeter()
Quadratmeter
at line 427
static ProductUnit
cubicMeter()
Kubikmeter
at line 438
static (Kg)/1000
kilometer()
Kilometer
at line 449
static (Kg)/1000
centimeter()
Centimeter
at line 460
static TransformedUnit
millimeter()
Millimeter
at line 471
static AlternateUnit
lumen()
Lumen
at line 482
static AlternateUnit
lux()
Lux