Locale
class Locale extends Alvine
Die Locale-Klasse stellt eine zentrale Möglichkeit zur Definition von Länder-, Sprach- und Kulturunterschieden zur Verfügung. Eine neue Locale erhält man über die Factory-Methode Locale::getInstance(). Im gesamten System gibt es immer nur ein Locale-Objekt für jeden Locale-String.
$locale = \Alvine\i18n\Locale::getInstance('de-Latn-DE');
echo $locale->getDisplayName('it_CH'); // gibt tedesco (latino, Germania) aus
echo $locale->getDisplayName('en_GB'); // gibt German (Latin, Germany) aus
Traits
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. |
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
Methods
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
Rückgabe der Locale
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
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.
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.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
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 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.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
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.
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.
Neue Lokale erstellen
Lokale Zeichenkette zurückgeben. Über die Maske kann definiert werden, welche Teile in die Zeichenkette eingebunden werden sollen.
Methode um ein gültiges Locale-Objekt zu erhalten. Pro Locale-String wird ein zentrales Locale-Objekt erstellt und von der Methode get() zurück- gegeben.
Diese Funktion zerlegt eine Zeichenkette in ein Array mit den Schlüsseln language, region, script, variants, private und extensions zurück
Gibt einen für Menschen lesbare Bezeichnung der Locale aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
Region der Locale als ISO 3166 2-letter code in Großbuchstaben.
Region
Sprache
AngezeigteSprache
Gibt die Script-Bezeichnung zurück
Gibt einen für Menschen lesbare Bezeichnung der Schriftart aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
Gibt die Variante zurück
Lokale
Standard-Locale-Objekt von Alvine auf dem System
Setzt eine neue Standard-Locale. Als Parameter wird ein Locale-String (z.B. de-DE) erwartet.
Details
in SerializableImplementation at line 122
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.
in SerializableImplementation at line 193
bool
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 205
bool
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 228
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.
in SerializableImplementation at line 252
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.
at line 401
string
__toString()
Rückgabe der Locale
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;
in Alvine at line 222
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 231
__unset(string $name)
Zurücksetzen von Werten
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;
}
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.
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;
}
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!
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();
}
in Alvine at line 376
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
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)
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.
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)) {
// ...
}
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
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();
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
at line 114
protected
__construct(string $language = null, string $region = null, string $script = null, array $variants = null, array $extensions = null, array $private = null)
Neue Lokale erstellen
Der Konstruktor wird nur von der Factory-Funktion get() aufgerufen
at line 139
string
getLocaleString(array $mask = ['language', 'region', 'script', 'variant', 'extlang', 'private'])
Lokale Zeichenkette zurückgeben. Über die Maske kann definiert werden, welche Teile in die Zeichenkette eingebunden werden sollen.
at line 176
static Locale
getInstance(string $locale = null)
Methode um ein gültiges Locale-Objekt zu erhalten. Pro Locale-String wird ein zentrales Locale-Objekt erstellt und von der Methode get() zurück- gegeben.
Das Objekt merkt sich alle erzeugten Locale-Objekte und gibt falls nochmal ein Localeobjekt mit dem gleichen Locale-String benötigt wird das gespeicherte zurück.
Wenn kein Parameter übergeben wurde, so wird der Standardwert aus der php.ini ('intl.default_locale') oder wenn dieser nicht gesetzt ist, der Wert den die ICU Funktion uloc_getDefault() liefert genommen.
at line 215
static array
parseLocale(string $locale)
Diese Funktion zerlegt eine Zeichenkette in ein Array mit den Schlüsseln language, region, script, variants, private und extensions zurück
$l = \Alvine\i18n\Locale::get('en_Hans_CN_nedis_rozaj_x_prv1_prv2');
Object
language=en
region=CN
variant=
script=Hans
private=array(ROZAJ)
at line 260
string
getDisplayName(string $targetLocale = null)
Gibt einen für Menschen lesbare Bezeichnung der Locale aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
at line 271
string(2)
getRegion()
Region der Locale als ISO 3166 2-letter code in Großbuchstaben.
at line 287
string
getDisplayRegion(string $targetLocale = null)
Region
Gibt einen für Menschen lesbare Bezeichnung der Region aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
at line 301
string
getLanguage()
Sprache
Gibt die reine Sprachbezeichnung (ohne Zusatz) zurück Bei der Lokale de-DE würde de zurückgegeben.
at line 317
string
getDisplayLanguage(string $targetLocale = null)
AngezeigteSprache
Gibt einen für Menschen lesbare Bezeichnung der Sprache aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
at line 328
string
getScript()
Gibt die Script-Bezeichnung zurück
at line 342
string
getDisplayScript(string $targetLocale = null)
Gibt einen für Menschen lesbare Bezeichnung der Schriftart aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
at line 353
string
getVariant()
Gibt die Variante zurück
at line 364
string
getLocale()
Lokale
Text der die Lokale representiert
at line 373
static Locale
getDefault()
Standard-Locale-Objekt von Alvine auf dem System
at line 388
static boolean
setDefault(string $locale)
Setzt eine neue Standard-Locale. Als Parameter wird ein Locale-String (z.B. de-DE) erwartet.