Documentation

Calendar extends AbstractCalendar
in package

Kalender nach ISO 8601 (gregorianischer Kalender)

Die Kalenderklasse stellt eine Kalender zur Abstraktion des weltweit eingesetzten Gregorianische Kalender (bzw. ISO8601) dar. Für die Benutzung historischer oder religiöser Kalender sind andere Klassen, die ebenfalls von AbstractCalendar abgeleitet sind vorgesehen.

Die gregorianischen Kalenderreform (10-Tage-Sprung vom 4. auf den 15. Oktober 1582 und die neuen Schaltjahr-Regelungen ab 1600) ist nur auf den päpstliches Erlasses zur Reform des Kalenderwesens zu betrachten. Die tatsächliche Änderung, in den verschiedenen Ländern mit christlicher Zeitrechnung erfolgte Teilweise erst deutlich später:

1582 - Italien, kath. Deutschland, Frankreich und Spanien 1699 - Dänemark 1700 - prot. Deutschland 1752 - Großbritannien 1753 - Schweden 1873 - Japan 1875 - Ägypten 1912 - China 1918 - Russland 1923 - Griechenland 1927 - Türkei

Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine

since
20120904

Table of Contents

Constants

APIVERSION  = 1
Version der API-Version der Klasse.
APRIL  = 4
April
APRIL_NAME  = 'APRIL'
April
APRIL_SHORT  = 'APR'
AUGUST  = 8
August
AUGUST_NAME  = 'AUGUST'
AUGUST_SHORT  = 'AUG'
DECEMBER  = 12
Dezember
DECEMBER_NAME  = 'DECEMBER'
Dezember
DECEMBER_SHORT  = 'DEC'
FEBRUARY  = 2
Februar
FEBRUARY_NAME  = 'FEBRUARY'
Februar
FEBRUARY_SHORT  = 'FEB'
FRIDAY  = 5
Freitag
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
ISO  = 'ISO8601'
Klassenname des Kalenders
JANUARY  = 1
Januar
JANUARY_NAME  = 'JANUARY'
Januar
JANUARY_SHORT  = 'JAN'
JULY  = 7
Juli
JULY_NAME  = 'JULY'
Juli
JULY_SHORT  = 'JUL'
JUNE  = 6
Juni
JUNE_NAME  = 'JUNE'
Juni
JUNE_SHORT  = 'JUN'
MARCH  = 3
März
MARCH_NAME  = 'MARCH'
März
MARCH_SHORT  = 'MAR'
MAY  = 5
Mai
MAY_NAME  = 'MAY'
Mai
MAY_SHORT  = 'MAY'
MONDAY  = 1
Montag
NOVEMBER  = 11
November
NOVEMBER_NAME  = 'NOVEMBER'
November
NOVEMBER_SHORT  = 'NOV'
OCTOBER  = 10
Oktober
OCTOBER_NAME  = 'OCTOBER'
Oktober
OCTOBER_SHORT  = 'OCT'
SATURDAY  = 6
Samstag
SEPTEMBER  = 9
September
SEPTEMBER_NAME  = 'SEPTEMBER'
September
SEPTEMBER_SHORT  = 'SEP'
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.
SUNDAY  = 7
Sontag
THURSDAY  = 4
Donnerstag
TUESDAY  = 2
Dienstag
VERSION  = 2
Generelle Alvine-Version
WEDNESDAY  = 3
Mittwoch

Properties

$defaultname  : string
$hasAssociatedProperties  : boolean
$hash  : string
Eindeutige ID
$hasVolatileProperties  : boolean
$instances  : array
$month  : array
$monthShort  : array
$properties  : array
$registeredInstanceName  : string

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
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.
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.
getDateTimeFromISO8601()  : DateTime
Datumsobjekt erstellen
getDayInMonth()  : integer
Gibt die Tage im Monat zurück.
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
getMaximumSupportedDate()  : Date
Letzter unterstützter Tag im Kalender
getMinimumSupportedDate()  : Date
Erster unterstützter Tag im Kalender
getMonthFromName()  : integer
Wandelt einen Textmonat in eine Zahl um.
getRegisteredInstanceName()  : string
Name der registrierten Instanz
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.
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.
isLeapYear()  : boolean
Ist das Jahr ein Schaltjahr
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
__construct()  : mixed
Von der abstractFactory-Klasse kann keine Instanz direkt erstellt werden.
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
checkRange()  : mixed
Prüft das Datum

Constants

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

SEPTEMBER_NAME

September

public mixed SEPTEMBER_NAME = 'SEPTEMBER'

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.

public mixed SERIALVERSION = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version

public mixed VERSION = 2

Properties

$hash

Eindeutige ID

protected string $hash = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$month

protected array $month = [\Alvine\Date\Calendar::JANUARY => \Alvine\Date\Calendar::JANUARY_NAME, \Alvine\Date\Calendar::FEBRUARY => \Alvine\Date\Calendar::FEBRUARY_NAME, \Alvine\Date\Calendar::MARCH => \Alvine\Date\Calendar::MARCH_NAME, \Alvine\Date\Calendar::APRIL => \Alvine\Date\Calendar::APRIL_NAME, \Alvine\Date\Calendar::MAY => \Alvine\Date\Calendar::MAY_NAME, \Alvine\Date\Calendar::JUNE => \Alvine\Date\Calendar::JUNE_NAME, \Alvine\Date\Calendar::JULY => \Alvine\Date\Calendar::JULY_NAME, \Alvine\Date\Calendar::AUGUST => \Alvine\Date\Calendar::AUGUST_NAME, \Alvine\Date\Calendar::SEPTEMBER => \Alvine\Date\Calendar::SEPTEMBER_NAME, \Alvine\Date\Calendar::OCTOBER => \Alvine\Date\Calendar::OCTOBER_NAME, \Alvine\Date\Calendar::NOVEMBER => \Alvine\Date\Calendar::NOVEMBER_NAME, \Alvine\Date\Calendar::DECEMBER => \Alvine\Date\Calendar::DECEMBER_NAME]

Monate mit Zahl und englischem Namen

$monthShort

protected array $monthShort = [\Alvine\Date\Calendar::JANUARY => \Alvine\Date\Calendar::JANUARY_SHORT, \Alvine\Date\Calendar::FEBRUARY => \Alvine\Date\Calendar::FEBRUARY_SHORT, \Alvine\Date\Calendar::MARCH => \Alvine\Date\Calendar::MARCH_SHORT, \Alvine\Date\Calendar::APRIL => \Alvine\Date\Calendar::APRIL_SHORT, \Alvine\Date\Calendar::MAY => \Alvine\Date\Calendar::MAY_SHORT, \Alvine\Date\Calendar::JUNE => \Alvine\Date\Calendar::JUNE_SHORT, \Alvine\Date\Calendar::JULY => \Alvine\Date\Calendar::JULY_SHORT, \Alvine\Date\Calendar::AUGUST => \Alvine\Date\Calendar::AUGUST_SHORT, \Alvine\Date\Calendar::SEPTEMBER => \Alvine\Date\Calendar::SEPTEMBER_SHORT, \Alvine\Date\Calendar::OCTOBER => \Alvine\Date\Calendar::OCTOBER_SHORT, \Alvine\Date\Calendar::NOVEMBER => \Alvine\Date\Calendar::NOVEMBER_SHORT, \Alvine\Date\Calendar::DECEMBER => \Alvine\Date\Calendar::DECEMBER_SHORT]

Kurze Monatsnamen mit Zahl und englischem Namen

$properties

protected array $properties = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

Methods

__call()

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

public __call(string $name, array $arguments) : mixed

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
$name : string

Funktionsname

$arguments : array

Argumente

Tags
throws
NotCallableException

Exception

Return values
mixed

Ergebnis des Callbacks

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

public __clone() : mixed

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

__get()

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.

public __get(string $name) : mixed

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Tags
throws
BadPropertyException
Return values
mixed

Wert der Eigenschaft

__isset()

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

public __isset(string $name) : boolean
Parameters
$name : string
Return values
boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.

public __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Tags
see
https://php.watch/versions/8.1/serializable-deprecated
Return values
array<string|int, mixed>

__set()

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

public __set(string $name, mixed $value) : void

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
$name : string

Name der Eigenschaft

$value : mixed

Wert der Eigenschaft

Return values
void

__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

public __toString() : string
echo (string) new MyObect();
Return values
string

Daten des Objekts

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

equals()

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.

public equals(Alvine $object) : boolean
class MyObject extends Alvine };

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

if($objA->equals($objB)) {
  // ...
}
Parameters
$object : Alvine

Objekt das überprüft werden soll

Return values
boolean

true wenn beide Objekte identisch sind.

getClass()

Name der Klasse

public getClass() : string
class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();
Tags
see
ClassType::getNormalizedName
Return values
string

Klassenname

getClone()

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

public getClone([boolean $deepClone = false ]) : Alvine

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
$deepClone : boolean = false

Clone aller enthaltenen Objekte

Tags
see
Alvine::__clone()
Return values
Alvine

getClosure()

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.

public getClosure(string $name) : Closure
Parameters
$name : string

Name des Closure

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getDateTimeFromISO8601()

Datumsobjekt erstellen

public getDateTimeFromISO8601(string $datetime) : DateTime

Diese Kalender-Methode erstellt aus einer Datumszeichenkette ein DateTime-Objekt, das im Rahmen dieses Kalenders gültig ist.

Parameters
$datetime : string

Datum im ISO8601 Format

Tags
throws
OutOfRangeException

Wenn das Datum außerhalb der Grenzen liegt.

Return values
DateTime

Im Kalender gültiges Datum

getDayInMonth()

Gibt die Tage im Monat zurück.

public getDayInMonth(integer $year, integer $month) : integer

Die Genauigkeit der Methode geht bis ca. 1550 n.Chr., da hier die Schaltjahre eingeführt wurden.

Parameters
$year : integer

Jahr

$month : integer

Monat

Return values
integer

Tage im angegebenen Monat

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
Return values
string

Hashwert des Objektes

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.

public getID() : string

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 values
string

UUID des Objektes

getInstance()

Instanz erstellen

public static getInstance([string $name = null ]) : object

Erstellt ein neues Objekt und registriert die Instanz unter dem Namen $name oder, wenn kein Name angegeben wurde mit dem Namen default. Ist bereits ein Objekt mit dem übergebenen Namen registriert, so wird dieser zurückgegeben.

Parameters
$name : string = null

Unter diesem Namen wird das Objekt registriert

Tags
throws
FrameworkException

Wenn die Klasse nicht ermittelt werden kann.

Return values
object

Neues oder registriertes Objekt

getMaximumSupportedDate()

Letzter unterstützter Tag im Kalender

public getMaximumSupportedDate() : Date
Return values
Date

Erster Tag im Kalender

getMinimumSupportedDate()

Erster unterstützter Tag im Kalender

public getMinimumSupportedDate() : Date
Return values
Date

Erster Tag im Kalender

getMonthFromName()

Wandelt einen Textmonat in eine Zahl um.

public getMonthFromName(string $month) : integer
Parameters
$month : string

englischer Monat in der Voll oder Kurzschreibweise - 3 Buchstaben)

Return values
integer

Monatswert

getRegisteredInstanceName()

Name der registrierten Instanz

public getRegisteredInstanceName() : string
Return values
string

Name

getShortID()

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.

public getShortID([int|null $length = null ]) : string

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
$length : int|null = null
Return values
string

isCallable()

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

public isCallable(string $name) : bool
if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}
Parameters
$name : string

Name der Methode

Return values
bool

Ergebnis

isInstanceOf()

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.

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

Die Prüfung entspricht

$this instanceof $object
Parameters
$object : object
Return values
boolean

isLeapYear()

Ist das Jahr ein Schaltjahr

public isLeapYear(integer $year) : boolean

Ein Schaltjahr ist, wenn die Jahreszahl durch 4 teilbar ist. Ausnahme 1: Ist die Jahreszahl durch 100 (kein Schaltjahr), Ausnahme 2: Ist die Jahreszahl durch 400 teilbar (ist immer ein Schaltjahr)

Parameters
$year : integer

Jahr

Return values
boolean

Schaltjahr

propertyExists()

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

public propertyExists(string $name) : boolean
if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Return values
boolean

__construct()

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

protected __construct() : mixed

checkAndAdjustSerialisation()

Dealing with versions

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

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters
$serialization : array

Daten des serialisiertes Objekts

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed>

checkRange()

Prüft das Datum

protected checkRange(Instant $instant) : mixed
Parameters
$instant : Instant

Prüfwert

Tags
throws
OutOfRangeException

Datum ausserhalb des Kalenders


        
On this page

Search results