Mail

Serialisieren

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.

Prüfen ob das Objekt associative Eigenschaften besitzt

Prüfen ob das Objekt volatile Eigenschaften besitzt

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.

Klasse deserialisieren

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

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;

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Zurücksetzen von Werten

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

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.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

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!

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

Die Methode Alvine::getID() verwenden!

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)

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 hilreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.

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)) {
  // ...
}

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

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.

Name der Klasse

class MyObject extends Alvine {};
$obj = new MyObject();

echo $obj->getClass();

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

Erstellt eine neue E-Mail.

Setzt das Datum explizit.

Das aktuelle Datum wird beim erstellen gesetzt. Mit dieser Methode kann es überschrieben werden.

Fügt einen neuen Inhalt zur Mail hinzu.

Bequemlichkeitsfunktion um eine Mail mit einem alternativen Mailinhalt zu erstellen. Als Parameter können entweder MailPart Objekte oder ein String übergeben werden.

Je nach Typ werden die Inhalte entweder alternativ (ALTERNATIVE), oder gleichzeitig (MIXED) im Mailprogramm angezeigt. Die genaue Darstellung hängt jedch vom Mailprogramm ab.

$mail = new \Alvine\Net\Mail\Mail('[email protected]','[email protected]','Testmail');
$mail->addAlternativeParts('<html><body>HTML-Teil</body></html>,'Text-Teil');

Gibt ein Mail-Address-Objekt zurück.

Gibt ein Array mit allen Empfänger, egal ob To, CC oder BCC zurück.

Anhand der Empfänger lässt sich nicht erkennen, in welchem Feld die E-Mail-Adresse steht.

Interne Methode um einen Empfänger hinzuzufügen. Diese Methode ruft sich selber auf, wenn das Argument ein Array ist, rekursion!

Fügt neuen Empfänger (to) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Fügt neuen Empfänger (cc) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Setzt den Absender (from) der Mail. Es kann entweder ein MailAddressObjekt oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Dann wird allerdings nur die erste E-Mail-Adresse verwendet

Falls kein ReplyTo gesetzt wurde, so setzt diese Funktion die Adresse auch als ReplyTo-Adresse.

Setzt den Rücksendeadresse (replyTo) der Mail. Es kann entweder ein MailAddressObjekt oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Fügt neuen Empfänger (bcc) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Setzt den Betreff der Mail

Wandelt den Betreff einer Mail in einen mailkonformen String um.

Diese Funktion erstellt den Quelltext der E-Mail.

Bequemlichkeitsfunktion zum senden der Mail. Es wird ein Standard SMTP-Server aufgerufen und die Mail an diesen übergeben. Der Versand erfolgt sofort.

$mail = new \Alvine\Net\Mail\Mail(); $mail->addTo('[email protected]')->setFrom('[email protected]')->setSubject('Testmail')->addAlternativeParts('', 'plain')->send();