Documentation

Second extends Instant
in package

Die Sekundenklasse steht für Berechnungen mit Sekunden spezielle Funktionen zur Verfügung.

$date = new Second(103);

Wichtig in diesem Zusammenhang ist, dass die Sekundenklasse nicht von Time sondern von Instant abgeleitet ist und somit der Wertebereich nicht auf 0..59 beschränkt ist.

Es können somit auch Timestamps in Sekunden-Objekte abgebildet werden.

Tags
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 Sekunden-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
Ausgabe der Sekunden als String
__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()  : Instant
Neues Second-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.

Constants

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

HOURMINUTEMASK

Stundenminuten-Maske

public mixed HOURMINUTEMASK = 12

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

NANOSECONDMASK

Maske Nanosekunde

public mixed NANOSECONDMASK = 1

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)

$mask

Schalter mit den belegten Feldern

protected integer $mask = null

Belegungsplan der Werte

$properties

protected array $properties = []

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

$year

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

protected integer $year = null

Jahreszahl

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.

__construct()

Der Konstruktor erstell ein neues Sekunden-Objekt.

public __construct([integer $second = 0 ]) : mixed
Parameters
$second : integer = 0

Sekunde

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

Ausgabe der Sekunden als String

public __toString() : string
Return values
string

Sekunden

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

fromDate()

Erstellt ein neues Quantity-Objekt von einer Datumsangabe

public static fromDate(integer $year[, integer $month = 0 ][, integer $day = 0 ]) : Quantity
Parameters
$year : integer

Jahr

$month : integer = 0

Monat

$day : integer = 0

Tag

Return values
Quantity

Dieses Objekt

fromString()

Parser

public static fromString(string $datetime) : Quantity

Alias-Methode für getInstanceFromISO8601()

Parameters
$datetime : string

Zeichenkette im ISO-Format

Return values
Quantity

Neue Quantity Instanz

fromTime()

Erstellt ein neues Quantity-Objekt von einer Zeitangabe

public static fromTime(integer $hour[, integer $minute = 0 ][, integer $second = 0 ][, integer $nanosecond = 0 ]) : mixed
Parameters
$hour : integer

Stunde

$minute : integer = 0

Minute

$second : integer = 0

Sekunde

$nanosecond : integer = 0

Nanosekunden

fromTimestamp()

Neues Second-Objekt aus einem Zeitstempel erstellen.

public static fromTimestamp(integer|Timestamp $timestamp) : Instant
Parameters
$timestamp : integer|Timestamp

Zeitstempel

Return values
Instant

Neues Objekt

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

getDay()

Gibt den Tag zurück

public getDay() : integer
Return values
integer

Tag

getHashCode()

Die Methode Alvine::getID() verwenden!

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

Hashwert des Objektes

getHour()

Gibt die Stunde zurück

public getHour() : integer
Return values
integer

Stunde

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

getInstanceFromISO8601()

Parser

public static getInstanceFromISO8601(string $datetime) : Quantity

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

Zeichenkette im ISO-Format

Tags
see
http://de.wikipedia.org/wiki/ISO_8601

Iso-Standard

throws
ParseException

Falsches Format

Return values
Quantity

Neue Quantity Instanz

getMinute()

Gibt die Minuten zurück

public getMinute() : integer
Return values
integer

Minute

getMonth()

Gibt den Monat zurück

public getMonth() : integer
Return values
integer

Monat

getNanoSecond()

Liefert die Nanosekunden zurück

public getNanoSecond() : integer
Return values
integer

Nanosekunden

getSecond()

Gibt die Sekunden zurück

public getSecond() : integer
Return values
integer

Sekunde

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

getYear()

Gibt das Jahr zurück.

public getYear() : integer
Return values
integer

Jahr

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

isZero()

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

public isZero() : boolean
Return values
boolean

Ergebnis

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

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>

checkMask()

Maske prüfen

protected checkMask(integer $mask) : boolean

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

Parameters
$mask : integer

Maske auf die geprüft werden soll

Return values
boolean

true, wenn die Maske identisch ist.

checkParts()

Interne Hilfsfunktion

protected static checkParts(array &$date, array &$time, array &$ns) : Quantity
Parameters
$date : array
$time : array
$ns : array
Return values
Quantity

createFromParts()

Instanz erstellen

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

Interne Methode zur Erstellung eines Objektes aus Teilen.

Parameters
$date : array

Datum (0=>Jahr,1=>Monat,2=>Tag)

$time : array

Zeit (0=>Stunde, 1=>Minute, 2=>Sekunde)

$ns : integer

Nanosekunden

Return values
Quantity

Neues Objekt

setDay()

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

protected setDay(integer $day) : Quantity
Parameters
$day : integer

Tag

Return values
Quantity

Dieses Objekt

setHour()

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

protected setHour(integer $hour) : Quantity
Parameters
$hour : integer

Stunde

Return values
Quantity

Dieses Objekt

setMinute()

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

protected setMinute(integer $minute) : Quantity
Parameters
$minute : integer
Return values
Quantity

Dieses Objekt

setMonth()

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

protected setMonth(integer $month) : Quantity
Parameters
$month : integer

Monat

Return values
Quantity

Dieses Objekt

setNanoSecond()

Setzt die Nanosekunden

protected setNanoSecond(integer $nanosecond) : mixed
Parameters
$nanosecond : integer

Nanosekunden

setSecond()

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

protected setSecond(integer $second) : Quantity
Parameters
$second : integer

Sekunde

Return values
Quantity

setYear()

Setzt das Jahr.

protected setYear(integer $year) : Quantity
Parameters
$year : integer

Jahr

Return values
Quantity

Dieses Objekt


        
On this page

Search results