Documentation

MailPartMultipart extends MailPart
in package

Bestanteil einer Mail, die mehrere Bestanteile enthalten kann.

So wird eine Mail die sowohl HTML als auch einen alternativen Bestandteil aus einfachen Text enthält so formattiert.

Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine
since
20110904

Table of Contents

Constants

ALTERNATIVE  = 'alternative'
Die Bestandteile sind als alternativen gedacht.
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
BASE64  = \ENCBASE64
Codierung als BASE64
BINARY  = \ENCBINARY
Codierung in Binary
BIT8  = \ENC8BIT
Codierung als 8bit
DEFAULT_KEY  = 'application/octet-stream'
Text-Schlüssel
GZIP  = 257
Codierung erfolgt als GZIP (256 + 1)
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
IMAGE  = \TYPEIMAGE
Bilder
IMAGE_KEY  = 'image'
Bild-Schlüssel
MESSAGE  = \TYPEMESSAGE
Mailnachricht
MESSAGE_KEY  = 'message'
Messages
MIXED  = 'mixed'
Es sind gemischte Bestandteile enthalten
MODEL  = \TYPEMODEL
3D Modell
MODEL_KEY  = 'model'
4D Modell
MULTIPART  = \TYPEMULTIPART
Sonstiges
MULTIPART_KEY  = 'multipart'
multipart
ORIGINAL  = 0
Ohne Encoding
OTHER  = \TYPEOTHER
Sonstiges
OTHER_KEY  = 'other'
Sonstiges
PARALLEL  = 'parallel'
Wird von den meisten Mailprogrammen nicht unterstützt
QUOTEDPRINTABLE  = \ENCQUOTEDPRINTABLE
Quoted Printable
RELATED  = 'related'
Die Bestandteile sind relativ zueinander.
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

$content  : string
$encoding  : integer
$hasAssociatedProperties  : boolean
$hash  : string
Eindeutige ID
$hasVolatileProperties  : boolean
$parts  : array
$properties  : array
$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
Ertellt einen neuen Bestandteil einer Mail, der weitere Bestandteile enthalten kann. *
__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
addPart()  : MailPartMultipart
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
getEncoding()  : integer
Kodierung
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()  : Content
Neue Instanz erstellen
getMimeType()  : string
Gibt en MimeType als String zurück (z.B. image/gif)
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
initDefinition()  : MailPart
Inititalisiert die Mailstruktur
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.
setEncoding()  : $this
Kodierung setzen
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
getEncodedContent()  : string
Kodierter Inhalt

Constants

ALTERNATIVE

Die Bestandteile sind als alternativen gedacht.

public mixed ALTERNATIVE = 'alternative'

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'

BASE64

Codierung als BASE64

public mixed BASE64 = \ENCBASE64

DEFAULT_KEY

Text-Schlüssel

public mixed DEFAULT_KEY = 'application/octet-stream'

GZIP

Codierung erfolgt als GZIP (256 + 1)

public mixed GZIP = 257

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

MULTIPART_KEY

multipart

public mixed MULTIPART_KEY = 'multipart'

QUOTEDPRINTABLE

Quoted Printable

public mixed QUOTEDPRINTABLE = \ENCQUOTEDPRINTABLE

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

$encoding

protected integer $encoding = null

Kodierung (nicht Zeichensatz, sondern gzip, etc)

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

$properties

protected array $properties = []

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

$typeMap

protected static int $typeMap = []

Nachschlageliste der MIME-Types

Tags
deprecated

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

Ertellt einen neuen Bestandteil einer Mail, der weitere Bestandteile enthalten kann. *

public __construct([string $subType = MailPartMultipart::MIXED ]) : mixed
Parameters
$subType : string = MailPartMultipart::MIXED

Untertyp

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

public __toString() : string 
echo (string) new MyObect();
Return values
string —

Daten des Objekts

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

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

getEncoding()

Kodierung

public getEncoding() : integer

Holt die Codierung (Base64 oder quotedprintable)

Return values
integer —

Kodierung

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
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()

Neue Instanz erstellen

public static getInstance(string $content, MIMEType $mimetype) : Content

Neue Instanz anhand eines MIMETypes erstellen

Parameters
$content : string

Inhalt

$mimetype : MIMEType

MIMEType

Tags
throws
UnsupportedMIMETypeException
Return values
Content —

Ein spezialisiertes Content-Objekt in Abhängigkeit des MIMETypes

getMimeType()

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

public getMimeType() : string
Return values
string —

MimeType-String

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>

initDefinition()

Inititalisiert die Mailstruktur

public initDefinition(array &$body[, array $parameter = array() ]) : MailPart
Parameters
$body : array

Referenz auf eine Body-Liste

$parameter : array = array()

Parameter

Return values
MailPart —

Dieses Objekt

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

setEncoding()

Kodierung setzen

public setEncoding(integer $encoding) : $this

Setzt die Kodierung (Base64, quotedprintable oder gzip). Wird gzip verwendet, so kommt als Kompressionsfaktor 9 zum Einsatz.

Parameters
$encoding : integer

Codierung

Tags
throws
OutOfRangeException
throws
TypeException
Return values
$this

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>

getEncodedContent()

Kodierter Inhalt

protected getEncodedContent() : string

Der Inhalt wird mittels dem in $this->encoding definierten Verfahren codiert. Wird gzip verwedent, so kommt als Kompressionsfaktor 9 zum Einsatz.

Return values
string —

Kodierter Inhalt


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results