class MonthDay extends Instant

Die MonthDay-Klasse ist eine spezialisierte Instant Klasse zur Darstellung eines Tages-Monats Datums (z.B.

für Geburtstage).

$monthDay = new MonthDay(12,31);
echo (string)$monthDay; // 12-31

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.

DATEMASK

Datumsmaske

DATETIMEMASK

Datumszeitmaske

TIMEMASK

Zeitmaske (H:m:s)

YEARMONTHMASK

JahrMonat Maske

MONTHDAYMASK

Monatstages-Maske

HOURMINUTEMASK

Stundenminuten-Maske

YEARMASK

Maske Jahr

MONTHMASK

Maske Monat

DAYMASK

Maske Tag

HOURMASK

Maske Stunde

MINUTEMASK

Maske

SECONDMASK

Maske Minute

NANOSECONDMASK

Maske Nanosekunde

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected $nanosecond Nanosekunden from Quantity
protected integer $second Sekunde from Quantity
protected integer $minute Minute from Quantity
protected integer $hour Stunde from Quantity
protected integer $day Tag from Quantity
protected integer $month Monat from Quantity
protected integer $year Im gregorianischen Kalender ist eine positive Jahreszahl nach Christus und eine negative Zahl vor Christus zu interpretieren. from Quantity
protected integer $mask Schalter mit den belegten Feldern from Quantity

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

Der Zeitpunkt wird im DIN EN 28601 Format MM-DD ausgeben.

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
__construct(integer $month, integer $day)

Der Konstruktor erstell ein neues Objekt.

boolean
checkMask(integer $mask)

Maske prüfen

from Quantity
integer
getNanoSecond()

Liefert die Nanosekunden zurück

from Quantity
setNanoSecond(integer $nanosecond)

Setzt die Nanosekunden

from Quantity
integer
getSecond()

Gibt die Sekunden zurück

from Quantity
setSecond(integer $second)

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

from Quantity
integer
getMinute()

Gibt die Minuten zurück

from Quantity
setMinute(integer $minute)

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

from Quantity
integer
getHour()

Gibt die Stunde zurück

from Quantity
setHour(integer $hour)

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

from Quantity
integer
getDay()

Gibt den Tag zurück

from Quantity
setDay(integer $day)

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

from Quantity
integer
getMonth()

Gibt den Monat zurück

from Quantity
setMonth(integer $month)

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

from Quantity
integer
getYear()

Gibt das Jahr zurück.

from Quantity
setYear(integer $year)

Setzt das Jahr.

from Quantity
static Quantity
fromDate(integer $year, integer $month = 0, integer $day = 0)

Erstellt ein neues Quantity-Objekt von einer Datumsangabe

from Quantity
static 
fromTime(integer $hour, integer $minute = 0, integer $second = 0, integer $nanosecond = 0)

Erstellt ein neues Quantity-Objekt von einer Zeitangabe

from Quantity
static Quantity
fromString(string $datetime)

Parser

from Quantity
static Quantity
getInstanceFromISO8601(string $datetime)

Parser

from Quantity
static Quantity
checkParts(array $date, array $time, array $ns)

Interne Hilfsfunktion

from Quantity
static Quantity
createFromParts(array $date, array $time, integer $ns)

Instanz erstellen

static Quantity
fromTimestamp(integer|Timestamp $timestamp)

Neues Quantity-Objekt aus einem Zeitstempel erstellen.

from Quantity
static DateTime
fromNow()

Zeitobjekt mit aktueller Zeit erstellen.

from Quantity
boolean
isZero()

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

from Quantity

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

at line 67
string __toString()

Der Zeitpunkt wird im DIN EN 28601 Format MM-DD ausgeben.

$monthDay = new MonthDay(31,12);
echo $monthDay; // 31-12

Return Value

string Daten des Objekts

See also

http://de.wikipedia.org/wiki/ISO_8601 ISO-Standard

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 47
__construct(integer $month, integer $day)

Der Konstruktor erstell ein neues Objekt.

Parameters

integer $month Monat
integer $day Tag

in Quantity at line 231
protected boolean checkMask(integer $mask)

Maske prüfen

Prüft ob die notwendigen Maske identisch zu der übergebenen ist und damit ob der Datentyp identisch ist.

Parameters

integer $mask Maske auf die geprüft werden soll

Return Value

boolean true, wenn die Maske identisch ist.

in Quantity at line 241
integer getNanoSecond()

Liefert die Nanosekunden zurück

Return Value

integer Nanosekunden

in Quantity at line 251
protected setNanoSecond(integer $nanosecond)

Setzt die Nanosekunden

Parameters

integer $nanosecond Nanosekunden

in Quantity at line 262
integer getSecond()

Gibt die Sekunden zurück

Return Value

integer Sekunde

in Quantity at line 277
protected Quantity setSecond(integer $second)

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

Parameters

integer $second Sekunde

Return Value

Quantity

in Quantity at line 288
integer getMinute()

Gibt die Minuten zurück

Return Value

integer Minute

in Quantity at line 303
protected Quantity setMinute(integer $minute)

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

Parameters

integer $minute

Return Value

Quantity Dieses Objekt

in Quantity at line 314
integer getHour()

Gibt die Stunde zurück

Return Value

integer Stunde

in Quantity at line 329
protected Quantity setHour(integer $hour)

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

Parameters

integer $hour Stunde

Return Value

Quantity Dieses Objekt

in Quantity at line 340
integer getDay()

Gibt den Tag zurück

Return Value

integer Tag

in Quantity at line 355
protected Quantity setDay(integer $day)

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

Parameters

integer $day Tag

Return Value

Quantity Dieses Objekt

in Quantity at line 366
integer getMonth()

Gibt den Monat zurück

Return Value

integer Monat

in Quantity at line 381
protected Quantity setMonth(integer $month)

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

Parameters

integer $month Monat

Return Value

Quantity Dieses Objekt

in Quantity at line 392
integer getYear()

Gibt das Jahr zurück.

Return Value

integer Jahr

in Quantity at line 404
protected Quantity setYear(integer $year)

Setzt das Jahr.

Parameters

integer $year Jahr

Return Value

Quantity Dieses Objekt

in Quantity at line 419
static Quantity fromDate(integer $year, integer $month = 0, integer $day = 0)

Erstellt ein neues Quantity-Objekt von einer Datumsangabe

Parameters

integer $year Jahr
integer $month Monat
integer $day Tag

Return Value

Quantity Dieses Objekt

in Quantity at line 436
static fromTime(integer $hour, integer $minute = 0, integer $second = 0, integer $nanosecond = 0)

Erstellt ein neues Quantity-Objekt von einer Zeitangabe

Parameters

integer $hour Stunde
integer $minute Minute
integer $second Sekunde
integer $nanosecond Nanosekunden

in Quantity at line 454
static Quantity fromString(string $datetime)

Parser

Alias-Methode für getInstanceFromISO8601()

Parameters

string $datetime Zeichenkette im ISO-Format

Return Value

Quantity Neue Quantity Instanz

in Quantity at line 488
static Quantity getInstanceFromISO8601(string $datetime)

Parser

Die parse-Funktion fromString erstellt aus einer übergebenen Zeichenkette im ISO8601 Format YYYY-MM-DDTHH:MM:SS ein neues Quantity Objekt.

Die Zeichenkette muss im Format YYYY-MM-DDTHH:MM:SS angegeben sein. Nicht erkannte Zeichen führen in der Quantity-Klasse zu keiner Exception, sondern zu 00 Werten (siehe Beispiele). In einer abgeleiteten Klasse (z.B. DateTime) kann ein Fehler beim parsen, aber zu einer MissingPropertyException führen.

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

Wird eine Zeitzone angegeben, so wird das Speicherformat in eine Zeit zur GMT umgerechnet, so dass die gespeicherte Zeit keinen Offset besitzt.

Parameters

string $datetime Zeichenkette im ISO-Format

Return Value

Quantity Neue Quantity Instanz

Exceptions

ParseException Falsches Format

See also

http://de.wikipedia.org/wiki/ISO_8601 Iso-Standard

in Quantity at line 536
static protected Quantity checkParts(array $date, array $time, array $ns)

Interne Hilfsfunktion

Parameters

array $date
array $time
array $ns

Return Value

Quantity

at line 83
static protected Quantity createFromParts(array $date, array $time, integer $ns)

Instanz erstellen

Interne Methode zur Erstellung eines Objektes aus Teilen.

Parameters

array $date Datum (0=>Jahr,1=>Monat,2=>Tag)
array $time Zeit (0=>Stunde, 1=>Minute, 2=>Sekunde)
integer $ns Nanosekunden

Return Value

Quantity Neues Objekt

in Quantity at line 599
static Quantity fromTimestamp(integer|Timestamp $timestamp)

Neues Quantity-Objekt aus einem Zeitstempel erstellen.

Für die Umwandlung kommt die Funktion date() zum Einsatz

Parameters

integer|Timestamp $timestamp Zeitstempel

Return Value

Quantity Neues Objekt

in Quantity at line 617
static DateTime fromNow()

Zeitobjekt mit aktueller Zeit erstellen.

Return Value

DateTime Neues Objekt

in Quantity at line 626
boolean isZero()

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

Return Value

boolean Ergebnis