abstract class MetricPrefix extends Alvine

Diese Klasse stellt Methoden und Konstanten für Umrechnung und Symbol im Metrischen System zur Verfügung.

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.

BASE

Basis des Hochrechnung

YOTTA_PREFIX

SI Einheitenpräfix YOTTA 10^24

YOTTA_SYMBOL

SI-Symbol

YOTTA_EXPONENT

Exponent

ZETTA_PREFIX

SI Einheitenpräfix ZETTA 10^21

ZETTA_SYMBOL

SI-Symbol

ZETTA_EXPONENT

Exponent

EXA_PREFIX

SI Einheitenpräfix EXA 10^18

EXA_SYMBOL

SI-Symbol

EXA_EXPONENT

Exponent

PETA_PREFIX

SI Einheitenpräfix PETA 10^15

PETA_SYMBOL

SI-Symbol

PETA_EXPONENT

Exponent

TERA_PREFIX

SI Einheitenpräfix TERA 10^12

TERA_SYMBOL

SI-Symbol

TERA_EXPONENT

Exponent

GIGA_PREFIX

SI Einheitenpräfix GIGA 10^9

GIGA_SYMBOL

SI-Symbol

GIGA_EXPONENT

Exponent

MEGA_PREFIX

SI Einheitenpräfix MEGA 10^6

MEGA_SYMBOL

SI-Symbol

MEGA_EXPONENT

Exponent

KILO_PREFIX

SI Einheitenpräfix KILO 10^3

KILO_SYMBOL

SI-Symbol

KILO_EXPONENT

Exponent

HECTO_PREFIX

SI Einheitenpräfix HECTO 10^2

HECTO_SYMBOL

SI-Symbol

HECTO_EXPONENT

Exponent

DECA_PREFIX

SI Einheitenpräfix DECA 10^1

DECA_SYMBOL

SI-Symbol

DECA_EXPONENT

Exponent

DECI_PREFIX

SI Einheitenpräfix DECI 10^-1

DECI_SYMBOL

SI-Symbol

DECI_EXPONENT

Exponent

CENTI_PREFIX

SI Einheitenpräfix CENTI 10^-2

CENTI_SYMBOL

SI-Symbol

CENTI_EXPONENT

Exponent

MILLI_PREFIX

SI Einheitenpräfix MILLI 10^-3

MILLI_SYMBOL

SI-Symbol

MILLI_EXPONENT

Exponent

MICRO_PREFIX

SI Einheitenpräfix MICRO 10^-6

MICRO_SYMBOL

SI-Symbol

MICRO_EXPONENT

Exponent

NANO_PREFIX

SI Einheitenpräfix NANO 10^-9

NANO_SYMBOL

SI-Symbol

NANO_EXPONENT

Exponent

PICO_PREFIX

SI Einheitenpräfix PICO 10^-12

PICO_SYMBOL

SI-Symbol

PICO_EXPONENT

Exponent

FEMTO_PREFIX

SI Einheitenpräfix FEMTO 10^-15

FEMTO_SYMBOL

SI-Symbol

FEMTO_EXPONENT

Exponent

ATTO_PREFIX

SI Einheitenpräfix ATTO 10^-18

ATTO_SYMBOL

SI-Symbol

ATTO_EXPONENT

Exponent

ZEPTO_PREFIX

SI Einheitenpräfix ZEPTO 10^-21

ZEPTO_SYMBOL

SI-Symbol

ZEPTO_EXPONENT

Exponent

YOCTO_PREFIX

SI Einheitenpräfix YOCTA 10^-24

YOCTO_SYMBOL

SI-Symbol für Yocto

YOCTO_EXPONENT

Exponent

Properties

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

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

from Alvine
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 $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.

from Alvine
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
static Unit
yotta(Unit $unit)

No description

static Unit
zetta(Unit $unit)

No description

static Unit
exa(Unit $unit)

No description

static Unit
peta(Unit $unit)

No description

static Unit
tera(Unit $unit)

No description

static Unit
giga(Unit $unit)

No description

static Unit
mega(Unit $unit)

No description

static Unit
kilo(Unit $unit)

No description

static Unit
hecto(Unit $unit)

No description

static Unit
deka(Unit $unit)

No description

static Unit
deci(Unit $unit)

No description

static Unit
centi(Unit $unit)

No description

static Unit
milli(Unit $unit)

No description

static Unit
micro(Unit $unit)

No description

static Unit
nano(Unit $unit)

No description

static Unit
pico(Unit $unit)

No description

static Unit
femto(Unit $unit)

No description

static Unit
atto(Unit $unit)

No description

static Unit
zepto(Unit $unit)

No description

static Unit
yocto(Unit $unit)

No description

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

in Alvine at line 177
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

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

in Alvine at line 442
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)) {
  // ...
}

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 348
static Unit yotta(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 358
static Unit zetta(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 368
static Unit exa(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 379
static Unit peta(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 390
static Unit tera(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 401
static Unit giga(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 412
static Unit mega(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 423
static Unit kilo(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 434
static Unit hecto(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 445
static Unit deka(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 456
static Unit deci(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 467
static Unit centi(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 478
static Unit milli(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 489
static Unit micro(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 500
static Unit nano(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 511
static Unit pico(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 522
static Unit femto(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 533
static Unit atto(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 544
static Unit zepto(Unit $unit)

Parameters

Unit $unit

Return Value

Unit

at line 554
static Unit yocto(Unit $unit)

Parameters

Unit $unit

Return Value

Unit