Documentation

Locale extends Alvine
in package

Alvine

I18n

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

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
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.
VERSION = 2: Generelle Alvine-Version

Properties

$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$properties : array
$defaultLocale : Locale
$extensions : string
$language : string: ISO-Code für die Sprache
$locale : string
$localeMap : array
$private : string
$region : string: Der Ländercode (auch Landescode; engl. Country Code) definiert Kennziffern oder Kennbuchstaben für verschiedene Länder, Staaten und deren Verwaltungsgliederung.
$script : string: Internationaler Standard für Schriftsysteme.
$variants : 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: Rückgabe der Locale
__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.
getDefault() : Locale: Standard-Locale-Objekt von Alvine auf dem System
getDisplayLanguage() : string: AngezeigteSprache
getDisplayName() : string: Gibt einen für Menschen lesbare Bezeichnung der Locale aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
getDisplayRegion() : string: Region
getDisplayScript() : string: Gibt einen für Menschen lesbare Bezeichnung der Schriftart aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.
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() : Locale: 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.
getLanguage() : string: Sprache
getLocale() : string: Lokale
getLocaleString() : string: Lokale Zeichenkette zurückgeben. Über die Maske kann definiert werden, welche Teile in die Zeichenkette eingebunden werden sollen.
getRegion() : string: Region der Locale als ISO 3166 2-letter code in Großbuchstaben.
getScript() : string: Gibt die Script-Bezeichnung 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.
getVariant() : string: Gibt die Variante 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.
parseLocale() : array: Diese Funktion zerlegt eine Zeichenkette in ein Array mit den Schlüsseln language, region, script, variants, private und extensions zurück
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
setDefault() : boolean: Setzt eine neue Standard-Locale. Als Parameter wird ein Locale-String (z.B. de-DE) erwartet.
__construct() : mixed: Neue Lokale erstellen
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

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

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

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

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$properties


    protected
        array
    $properties
     = []

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

$defaultLocale


    private
    static    Locale
    $defaultLocale
     = null

Vom System vewrwendete Standard Locale

$extensions


    private
        string
    $extensions
     = null

Erweiterung der Locale

$language

ISO-Code für die Sprache


    private
        string
    $language
     = null

Sprache

$locale


    private
        string
    $locale
     = null

Zusammengesetzter Locale-String z.B. de_DE

$localeMap


    private
    static    array
    $localeMap
     = array()

Interner Zwischenspeicher für verwendete Locale

$private


    private
        string
    $private
     = null

Für private Verwendung. Der Tag beginnt mit einem x-

$region

Der Ländercode (auch Landescode; engl. Country Code) definiert Kennziffern oder Kennbuchstaben für verschiedene Länder, Staaten und deren Verwaltungsgliederung.


    private
        string
    $region
     = null

Region

$script

Internationaler Standard für Schriftsysteme.


    private
        string
    $script
     = null

Internationaler Standard für Schriftsysteme.

$variants


    private
        string
    $variants
     = null

Variante der Locale

__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

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

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.

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

Rückgabe der Locale


    public
                    __toString() : string

Return values

string —

Locale (z.B. de-DE)

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

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

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

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

Return values

Closure

getDefault()

Standard-Locale-Objekt von Alvine auf dem System


    public
            static        getDefault() : Locale

Return values

Locale —

Locale

getDisplayLanguage()

AngezeigteSprache


    public
                    getDisplayLanguage([string $targetLocale = null ]) : string

Gibt einen für Menschen lesbare Bezeichnung der Sprache aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.

Parameters

$targetLocale : string = null: Ziel-Locale

Return values

string —

Name der Sprache

getDisplayName()

Gibt einen für Menschen lesbare Bezeichnung der Locale aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.


    public
                    getDisplayName([string $targetLocale = null ]) : string

Parameters

$targetLocale : string = null: Ziel-Lokale

Return values

string —

Name der Locale

getDisplayRegion()

Region


    public
                    getDisplayRegion([string $targetLocale = null ]) : string

Gibt einen für Menschen lesbare Bezeichnung der Region aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.

Parameters

$targetLocale : string = null: Ziel-Locale

Return values

string —

Name der Region

getDisplayScript()

Gibt einen für Menschen lesbare Bezeichnung der Schriftart aus. Wird ein Parameter übergeben, so wird der Bezeichner in dieser Locale ausgegeben.


    public
                    getDisplayScript([string $targetLocale = null ]) : string

Parameters

$targetLocale : string = null: Die Ziel-Locale

Return values

string —

Name der Schriftart (z.B. Lateinisch) *

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

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

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.


    public
            static        getInstance([string $locale = null ]) : Locale

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

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

Return values

Locale

getLanguage()

Sprache


    public
                    getLanguage() : string

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

Return values

string —

Sprache

getLocale()

Lokale


    public
                    getLocale() : string

Text der die Lokale representiert

Return values

string —

Locale String (z.B. de-DE)

getLocaleString()

Lokale Zeichenkette zurückgeben. Über die Maske kann definiert werden, welche Teile in die Zeichenkette eingebunden werden sollen.


    public
                    getLocaleString([array $mask = ['language', 'region', 'script', 'variant', 'extlang', 'private'] ]) : string

Parameters

$mask : array = ['language', 'region', 'script', 'variant', 'extlang', 'private']

Return values

string

getRegion()

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


    public
                    getRegion() : string

Return values

string —

Region

getScript()

Gibt die Script-Bezeichnung zurück


    public
                    getScript() : string

Return values

string —

Skriptum

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

getVariant()

Gibt die Variante zurück


    public
                    getVariant() : string

Return values

string —

Variante

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

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

parseLocale()

Diese Funktion zerlegt eine Zeichenkette in ein Array mit den Schlüsseln language, region, script, variants, private und extensions zurück


    public
            static        parseLocale(string $locale) : array

$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

$locale : string: Locale

Return values

array —

Array mit den Bestandteilen der übergebenen Locale

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

setDefault()

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


    public
            static        setDefault(string $locale) : boolean

Parameters

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

Return values

boolean —

false wenn ein Fehler aufgetreten ist, sonst true

__construct()

Neue Lokale erstellen


    protected
                    __construct([string $language = null ][, string $region = null ][, string $script = null ][, array $variants = null ][, array $extensions = null ][, array $private = null ]) : mixed

Der Konstruktor wird nur von der Factory-Funktion get() aufgerufen

Parameters

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

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

Return values

array<string|int, mixed>

Locale extends Alvine in package Alvine I18n

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$hasAssociatedProperties

$hash

$hasVolatileProperties

$properties

$defaultLocale

$extensions

$language

$locale

$localeMap

$private

$region

$script

Tags

$variants

Methods

__call()

Parameters

Tags

Return values

__clone()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

equals()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getDefault()

Return values

getDisplayLanguage()

Parameters

Return values

getDisplayName()

Parameters

Return values

getDisplayRegion()

Parameters

Return values

getDisplayScript()

Parameters

Return values

Locale extends Alvine
in package

Alvine

I18n