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

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.

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine

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

Rückgabe der Locale

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(string $language = null, string $region = null, string $script = null, array $variants = null, array $extensions = null, array $private = null)

Neue Lokale erstellen

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.

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.

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

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.

string(2)
getRegion()

Region der Locale als ISO 3166 2-letter code in Großbuchstaben.

string
getDisplayRegion(string $targetLocale = null)

Region

string
getLanguage()

Sprache

string
getDisplayLanguage(string $targetLocale = null)

AngezeigteSprache

string
getScript()

Gibt die Script-Bezeichnung zurück

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.

string
getVariant()

Gibt die Variante zurück

string
getLocale()

Lokale

static Locale
getDefault()

Standard-Locale-Objekt von Alvine auf dem System

static boolean
setDefault(string $locale)

Setzt eine neue Standard-Locale. Als Parameter wird ein Locale-String (z.B. de-DE) erwartet.

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 401
string __toString()

Rückgabe der Locale

Return Value

string Daten des Objekts

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

Parameters

string $language Sprache
string $region Region
string $script Skriptum
array $variants Varianten
array $extensions Erweiterungen
array $private Private Werte

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.

Parameters

array $mask

Return Value

string

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.

Parameters

string $locale String (z.B. de-DE)

Return Value

Locale

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)

Parameters

string $locale Locale

Return Value

array Array mit den Bestandteilen der übergebenen Locale

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.

Parameters

string $targetLocale Ziel-Lokale

Return Value

string Name der Locale

at line 271
string(2) getRegion()

Region der Locale als ISO 3166 2-letter code in Großbuchstaben.

Return Value

string(2) Region

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.

Parameters

string $targetLocale Ziel-Locale

Return Value

string Name der Region

at line 301
string getLanguage()

Sprache

Gibt die reine Sprachbezeichnung (ohne Zusatz) zurück Bei der Lokale de-DE würde de zurückgegeben.

Return Value

string Sprache

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.

Parameters

string $targetLocale Ziel-Locale

Return Value

string Name der Sprache

at line 328
string getScript()

Gibt die Script-Bezeichnung zurück

Return Value

string Skriptum

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.

Parameters

string $targetLocale Die Ziel-Locale

Return Value

string Name der Schriftart (z.B. Lateinisch) *

at line 353
string getVariant()

Gibt die Variante zurück

Return Value

string Variante

at line 364
string getLocale()

Lokale

Text der die Lokale representiert

Return Value

string Locale String (z.B. de-DE)

at line 373
static Locale getDefault()

Standard-Locale-Objekt von Alvine auf dem System

Return Value

Locale Locale

at line 388
static boolean setDefault(string $locale)

Setzt eine neue Standard-Locale. Als Parameter wird ein Locale-String (z.B. de-DE) erwartet.

Parameters

string $locale Zu verwendene Locale (z.B. de-DE)

Return Value

boolean false wenn ein Fehler aufgetreten ist, sonst true