Documentation

NonSI extends SystemOfUnits

in package

• Alvine
• Measure

Alternative Einheiten

Tags

category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine

since

20110904

Table of Contents

Constants

ANGSTROM  = 'Å'

ANGSTROM

APIVERSION  = 1

Version der API-Version der Klasse.

ASTRONOMICAL_UNIT  = 'ua'

ASTRONOMICAL_UNIT

ATOM  = 'u'

ATOM

AVOGADRO_CONSTANT  = 6.02214199E+23

Avogadro constant. (1/mol).

AVOIRDUPOIS_POUND_DIVIDEND  = 45359237

Pound: 0.45359237 kg exact

AVOIRDUPOIS_POUND_DIVISOR  = 100000000

CUBIC_INCH  = 'inc³'

CUBIC_INCH

DAY  = 'd'

DAY

ELEMENTARY_CHARGE  = 1.602176462E-19

Electric Charge of one electron. (C).

FAHRENHEIT  = '°F'

FAHRENHEIT

FOOT  = 'ft'

FOOT

GALLON_LIQUID_US  = 'gal'

GALLON_LIQUID_US

HOUR  = 'h'

HOUR

IDENTIFICATION  = 'Alvine'

Identifizierung der Alvine API

INCH  = 'in'

Inch

INTERNATIONAL_FOOT_DIVIDEND  = 3048

International Foot: 0.3048 m exact.

INTERNATIONAL_FOOT_DIVISOR  = 10000

KILOMETERS_PER_HOUR  = 'km/h'

KILOMETERS_PER_HOUR

LIGHT_YEAR  = 'ly'

LIGHT_YEAR

LITER  = 'l'

LITER

MILE  = 'mi'

Mile

MINUTE  = 'min'

MINUTE

NAUTICAL_MILE  = 'nmi'

Nautische Meile

PARSEC  = 'pc'

PARSEC

POINT  = 'pt'

POINT

RANKINE  = '°R'

RANKINE

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.

STANDARD_GRAVITY_DIVIDEND  = 980665

Standard-Anziehungskraft 9.80665 m/s² exact.

STANDARD_GRAVITY_DIVISOR  = 100000

VERSION  = 2

Generelle Alvine-Version

YARD  = 'yd'

Yard

Properties

$hasAssociatedProperties  : boolean

$hash  : string

Eindeutige ID

$hasVolatileProperties  : boolean

$instances  : array

$properties  : array

$units  : 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()  : string

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

__unserialize()  : void

__unset()  : mixed

Zurücksetzen von Werten

angstrom()  : Unit

Angstrom

astronomicalUnit()  : Unit

Astronomical Unit

atom()  : Unit

Ein Unikat

cubicInch()  : Unit

cubicInch

day()  : Unit

Tag

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.

fahrenheit()  : Unit

Fahrenheit

foot()  : Unit

Fuß

gallonLiquidUS()  : Unit

gallonLiquidUS

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.

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.

getInstance()  : object

Instanz erstellen

getOrCreateUnit()  : class

Erstellen von eindeutigen Einheiten

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|null

hasAssociatedProperties()  : boolean

Check if the object has associative properties

hasVolatileProperties()  : boolean

Prüfen ob das Objekt volatile Eigenschaften besitzt

hour()  : Unit

Stunde

inch()  : Unit

Inch

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

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.

kilometersPerHour()  : Unit

Kilometer pro Stunde

lightYear()  : Unit

Lichtjahr

liter()  : Unit

Liter

mile()  : Unit

Meile

minute()  : Unit

Minute

nauticalMile()  : Unit

Nautische Meile

parsec()  : Unit

Parsec

point()  : Unit

Point (pt)

propertyExists()  : boolean

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

rankine()  : Unit

Rankine

yard()  : Unit

Yard

__construct()  : mixed

Von der Singleton-Klasse kann keine Instanz direkt erstellt werden.

checkAndAdjustSerialisation()  : array<string|int, mixed>

Dealing with versions

// 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!

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

class MyObject extends Alvine {
}

$obj = new MyObject();
$obj->myValue = 4;

echo (string) new MyObect();

class MyObject extends Alvine };

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

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

class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

$this instanceof $object

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}