Documentation

MediaType extends MIMEType
in package

Alvine

Types

MediaTypes

Diese Klasse baut auf der MIME-Klasse auf und erweitert die MIME-Funktionaliät unter anderem um einen Qualitätsfaktor und weitere Parameter.

Constants

APIVERSION = 1: Version der API-Version der Klasse.
APPLICATION = \TYPEAPPLICATION: Allgemeine Binärdaten
APPLICATION_KEY = 'application': Anwendungsdaten
AUDIO = \TYPEAUDIO: Audios
AUDIO_KEY = 'audio': Audio-Schlüssel
DEFAULT_KEY = 'application/octet-stream': Text-Schlüssel
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
IMAGE = \TYPEIMAGE: Bilder
IMAGE_KEY = 'image': Bild-Schlüssel
MESSAGE = \TYPEMESSAGE: Mailnachricht
MESSAGE_KEY = 'message': Messages
MODEL = \TYPEMODEL: 3D Modell
MODEL_KEY = 'model': 4D Modell
MULTIPART = \TYPEMULTIPART: Sonstiges
MULTIPART_KEY = 'multipart': multipart
OTHER = \TYPEOTHER: Sonstiges
OTHER_KEY = 'other': Sonstiges
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.
TEXT = \TYPETEXT: Type Text
TEXT_KEY = 'text': Text-Schlüssel
VERSION = 2: Generelle Alvine-Version
VIDEO = \TYPEVIDEO: Videoas
VIDEO_KEY = 'video': Video-Schlüssel

Properties

$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$properties : array
$quality : float: Die Gewichtung kann einen Wert von 0 bis 1 annehmen.
$subtype : string
$type : int
$typeMap : int

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: Neue Klasse erstellen
__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.
getContentType() : string: Spezialisierte Zeichenkette mit Parametern
getDefaultMimeType() : MIMEType: Standard-Typ
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.
getMimeType() : string: Gibt en MimeType als String zurück (z.B. image/gif)
getParameter() : array: Parameter
getQuality() : float: Qualität
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.
getSubType() : string: Gibt den Untertyp zurück (z.B. gif)
getType() : string: Gibt den Haupttyp zurück (z.B. images)
getTypeMap() : array<string|int, mixed>: Typ-Map
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.
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

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

APPLICATION

Allgemeine Binärdaten


    public
        mixed
    APPLICATION
    = \TYPEAPPLICATION

APPLICATION_KEY

Anwendungsdaten


    public
        mixed
    APPLICATION_KEY
    = 'application'

AUDIO

Audios


    public
        mixed
    AUDIO
    = \TYPEAUDIO

AUDIO_KEY

Audio-Schlüssel


    public
        mixed
    AUDIO_KEY
    = 'audio'

DEFAULT_KEY

Text-Schlüssel


    public
        mixed
    DEFAULT_KEY
    = 'application/octet-stream'

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

IMAGE

Bilder


    public
        mixed
    IMAGE
    = \TYPEIMAGE

IMAGE_KEY

Bild-Schlüssel


    public
        mixed
    IMAGE_KEY
    = 'image'

MESSAGE

Mailnachricht


    public
        mixed
    MESSAGE
    = \TYPEMESSAGE

MESSAGE_KEY

Messages


    public
        mixed
    MESSAGE_KEY
    = 'message'

MODEL

3D Modell


    public
        mixed
    MODEL
    = \TYPEMODEL

MODEL_KEY

4D Modell


    public
        mixed
    MODEL_KEY
    = 'model'

MULTIPART

Sonstiges


    public
        mixed
    MULTIPART
    = \TYPEMULTIPART

MULTIPART_KEY

multipart


    public
        mixed
    MULTIPART_KEY
    = 'multipart'

OTHER

Sonstiges


    public
        mixed
    OTHER
    = \TYPEOTHER

OTHER_KEY

Sonstiges


    public
        mixed
    OTHER_KEY
    = 'other'

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

TEXT

Type Text


    public
        mixed
    TEXT
    = \TYPETEXT

TEXT_KEY

Text-Schlüssel


    public
        mixed
    TEXT_KEY
    = 'text'

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

VIDEO

Videoas


    public
        mixed
    VIDEO
    = \TYPEVIDEO

VIDEO_KEY

Video-Schlüssel


    public
        mixed
    VIDEO_KEY
    = 'video'

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

$quality

Die Gewichtung kann einen Wert von 0 bis 1 annehmen.


    protected
        float
    $quality
     = 1.0

Der Standardwert ist 1.0

Gewichtung des Medientypes gegenüber anderen Typen

$subtype


    protected
        string
    $subtype
     = null

Untertyp

$type


    protected
        int
    $type
     = null

Haupttyp

$typeMap


    protected
    static    int
    $typeMap
     = []

Nachschlageliste der MIME-Types

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

__construct()

Neue Klasse erstellen


    public
                    __construct(integer|string $type[, string $subtype = null ][, float $quality = 1.0 ][, array|null $parameter = null ]) : mixed

Definiert einen Inhaltstyp nach dem MIME-Spezifikation. Es kann entweder der Type und Subtype getrennt oder als ein Parameter übergeben werden.

Der optionale Parameter $quality setzt eine Gewichtung des Medientyps zu anderen. Weitere Parameter können zum Beispiel der DOM-Level bei HTML sein.

$mediatype=new \Alvine\Types\MediaType('image/gif');
echo (string) $mediatype;
// → image/gif

$mediatype=new \Alvine\Types\MediaType('image', 'gif');
echo (string) $mediatype;
// → image/gifimage/giftext/html

$mediatype=new \Alvine\Types\MediaType(\Alvine\Types\MediaType::IMAGE, \Alvine\Types\Mime\Image::GIF);
echo (string) $mediatype;
// → image/gif

// HTML mit Level
$mediatype=new \Alvine\Types\MediaType(\Alvine\Types\MediaType::TEXT, 'html', 1, ['level'=>1]);
echo (string) $mediatype;
// → text/html

Parameters

$type : integer|string: Typ (KEY oder ID)
$subtype : string = null: Untertyp des Teils
$quality : float = 1.0: Qualität / Gewichtung
$parameter : array|null = null: Weitere Parameter

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette


    public
                    __toString() : string

echo (string) new MyObect();

Return values

string —

Daten des Objekts

__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

getContentType()

Spezialisierte Zeichenkette mit Parametern


    public
                    getContentType() : string

Return values

string —

Zeichenkette

getDefaultMimeType()

Standard-Typ


    public
            static        getDefaultMimeType([string|null $type = null ]) : MIMEType

Diese Methode definiert für jeden Haupttypen und für die Übergabe von null einen wie folgt definierten Typen:

AUDIO audio/mpeg APPLICATION application/octet-stream IMAGE image\png MESSAGE message\rfc822 MODEL model\vrml OTHER other\x-unknown TEXT text/plain VIDEO video/mpeg

Parameters

$type : string|null = null: Der gewünschte Haupttyp

Return values

MIMEType —

Neues MIMETypeObjekt

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

getMimeType()

Gibt en MimeType als String zurück (z.B. image/gif)


    public
                    getMimeType() : string

Return values

string —

MimeType-String

getParameter()

Parameter


    public
                    getParameter() : array

Return values

array —

Parameter

getQuality()

Qualität


    public
                    getQuality() : float

Return values

float —

Qualität

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

getSubType()

Gibt den Untertyp zurück (z.B. gif)


    public
                    getSubType() : string

Return values

string —

Untertyp

getType()

Gibt den Haupttyp zurück (z.B. images)


    public
                    getType() : string

Return values

string —

Haupttyp

getTypeMap()

Typ-Map


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

Return values

array<string|int, mixed>

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

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

Return values

array<string|int, mixed>

MediaType extends MIMEType in package Alvine Types

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

APPLICATION

APPLICATION_KEY

AUDIO

AUDIO_KEY

DEFAULT_KEY

IDENTIFICATION

IMAGE

IMAGE_KEY

MESSAGE

MESSAGE_KEY

MODEL

MODEL_KEY

MULTIPART

MULTIPART_KEY

OTHER

OTHER_KEY

SERIALVERSION

TEXT

TEXT_KEY

VERSION

VIDEO

VIDEO_KEY

Properties

$hasAssociatedProperties

$hash

$hasVolatileProperties

$properties

$quality

$subtype

$type

$typeMap

Tags

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__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

MediaType extends MIMEType
in package

Alvine

Types