Documentation

Year extends Instant

in package

• Alvine
• Date

Die Year-Klasse ist eine spezialisierte Instant Klasse zur Darstellung einer Jahreszahl.

// VII. Olympische Spiele in Antwerpen
$date = new Year(1920);
echo (string)$date; // 1920

Tags

see

http://de.wikipedia.org/wiki/Olympische_Sommerspiele_1920

Olympische Sommerspiele 1920

category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine

since

20110904

Table of Contents

Constants

APIVERSION  = 1

Version der API-Version der Klasse.

DATEMASK  = 112

Datumsmaske

DATETIMEMASK  = 126

Datumszeitmaske

DAYMASK  = 16

Maske Tag

HOURMASK  = 8

Maske Stunde

HOURMINUTEMASK  = 12

Stundenminuten-Maske

IDENTIFICATION  = 'Alvine'

Identifizierung der Alvine API

MINUTEMASK  = 4

Maske

MONTHDAYMASK  = 48

Monatstages-Maske

MONTHMASK  = 32

Maske Monat

NANOSECONDMASK  = 1

Maske Nanosekunde

SECONDMASK  = 2

Maske Minute

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.

TIMEMASK  = 14

Zeitmaske (H:m:s)

VERSION  = 2

Generelle Alvine-Version

YEARMASK  = 64

Maske Jahr

YEARMONTHMASK  = 96

JahrMonat Maske

Properties

$day  : integer

Tag

$hasAssociatedProperties  : boolean

$hash  : string

Eindeutige ID

$hasVolatileProperties  : boolean

$hour  : integer

Stunde

$mask  : integer

Schalter mit den belegten Feldern

$minute  : integer

Minute

$month  : integer

Monat

$nanosecond  : mixed

Nanosekunden

$properties  : array

$second  : integer

Sekunde

$year  : integer

Im gregorianischen Kalender ist eine positive Jahreszahl nach Christus und eine negative Zahl vor Christus zu interpretieren.

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

Der Konstruktor erstell ein neues Objekt.

__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

Der Zeitpunkt wird im DIN EN 28601 Format JJJJ ausgeben.

__unserialize()  : void

__unset()  : mixed

Zurücksetzen von Werten

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.

fromDate()  : Quantity

Erstellt ein neues Quantity-Objekt von einer Datumsangabe

fromNow()  : DateTime

Zeitobjekt mit aktueller Zeit erstellen.

fromString()  : Quantity

Parser

fromTime()  : mixed

Erstellt ein neues Quantity-Objekt von einer Zeitangabe

fromTimestamp()  : Quantity

Neues Quantity-Objekt aus einem Zeitstempel erstellen.

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.

getDay()  : integer

Gibt den Tag zurück

getHashCode()  : string

Die Methode Alvine::getID() verwenden!

getHour()  : integer

Gibt die Stunde zurück

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.

getInstanceFromISO8601()  : Quantity

Parser

getMinute()  : integer

Gibt die Minuten zurück

getMonth()  : integer

Gibt den Monat zurück

getNanoSecond()  : integer

Liefert die Nanosekunden zurück

getSecond()  : integer

Gibt die Sekunden zurück

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.

getYear()  : integer

Gibt das Jahr zurück.

hasAssociatedProperties()  : boolean

Check if the object has associative properties

hasVolatileProperties()  : boolean

Prüfen ob das Objekt volatile Eigenschaften besitzt

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.

isZero()  : boolean

Gibt true zurück, wenn alle Werte auf 0 stehen.

propertyExists()  : boolean

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

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

Dealing with versions

checkMask()  : boolean

Maske prüfen

checkParts()  : Quantity

Interne Hilfsfunktion

createFromParts()  : Quantity

Instanz erstellen

setDay()  : Quantity

Setzt den Tag (Wertebereich 1-12). Ist der Wert außerhalb des Wertebereichs, so wird der Wert entsprechend auf die Grenze des Wertebereichs gesetzt.

setHour()  : Quantity

Setzt die Stunde (Wertebereich 0-23). Ist der Wert außerhalb des Wertebereichs, so wird der Wert entsprechend auf die Grenze des Wertebereichs gesetzt.

setMinute()  : Quantity

Setzt die Minuten (Wertebereich 0-59). Ist der Wert außerhalb des Wertebereichs, so wird der Wert entsprechend auf die Grenze des Wertebereichs gesetzt.

setMonth()  : Quantity

Setzt den Monat (Wertebereich 1-12). Ist der Wert außerhalb des Wertebereichs, so wird der Wert entsprechend auf die Grenze des Wertebereichs gesetzt.

setNanoSecond()  : mixed

Setzt die Nanosekunden

setSecond()  : Quantity

Setzt die Sekunden (Wertebereich 0-59). Ist der Wert außerhalb des Wertebereichs, so wird der Wert entsprechend auf die Grenze des Wertebereichs gesetzt.

setYear()  : Quantity

Setzt das Jahr.

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

$instant = new Year(1970);
echo $instant; // 1970

class MyObject extends Alvine };

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

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

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

echo $obj->getClass();

echo Alvine\Date\DateTime::fromString('FEHLER'); // 0000-00-00T00:00:00
echo Alvine\Date\DateTime::fromString('1970-10-09T14:25:21'); // 1970-10-09T14:25:21
echo Alvine\Date\DateTime::fromString('1970-10-FEHLER'); // 1970-10-00T00:00:00

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

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

$this instanceof $object

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