StatusCode
extends Alvine
in package
SMTP Status Code
Tags
Table of Contents
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.
- SMTP_ACCESS_DENIED = 530
- Access denied (???a Sendmailism)
- SMTP_ACTION_OK = 250
- Requested mail action okay, completed
- SMTP_AUTHENTICATION_ENCRYPTION_REQUIRED = 538
- Encryption required for requested authentication mechanism
- SMTP_AUTHENTICATION_IS_TO_WEAK = 534
- Authentication mechanism is to weak
- SMTP_AUTHENTICATION_REQUIRED = 530
- Authentication required
- SMTP_AUTHENTICATION_TEMPORARY_FAILURE = 454
- Temporary authentication failure
- SMTP_BAD_SEQUENCE = 503
- Bad sequence of commands
- SMTP_CANNOT_VERIFY_USER = 252
- Cannot VRFY user, but will accept message and attempt delivery
- SMTP_COMMAND_UNRECOGNISED = 500
- Syntax error, command unrecognised
- SMTP_DOES_NOT_ACCEPT_MAIL = 521
- <domain> does not accept mail (see rfc1846)
- SMTP_EXCEEDED_STORAGE_ALLOCATION = 552
- Requested mail action aborted: exceeded storage allocation
- SMTP_FORWARD = 251
- User not local;will forward to <forward-path>
- SMTP_HELP_MESSAGE = 214
- Help message
- SMTP_INSUFFICIENT_SYSTEM_STORAGE = 452
- Requested action not taken: insufficient system storage
- SMTP_MAILBOX_NAME_NOT_ALLOWED = 553
- Requested action not taken: mailbox name not allowed
- SMTP_MAILBOX_PERMANENT_UNAVAILABLE = 550
- Requested action not taken: mailbox unavailable (hard / dauerhaft)
- SMTP_MAILBOX_UNAVAILABLE = 450
- Requested mail action not taken: mailbox unavailable (soft / temporäre)
- SMTP_NOT_IMPLEMENTED = 502
- Command not implemented
- SMTP_PARAMETER_NOT_IMPLEMENTED = 504
- Command parameter not implemented
- SMTP_REQUEST_ABORTED = 451
- Requested action aborted: local error in processing
- SMTP_SERVICE_CLOSING_TRANSMISSION = 221
- <domain> Service closing transmission channel
- SMTP_SERVICE_NOT_AVAILABLE = 421
- <domain> Service not available, closing transmission channel
- SMTP_SERVICE_READY = 220
- <domain> Service ready
- SMTP_START_MAIL = 354
- Start mail input;end with <CRLF>.<CRLF>
- SMTP_SUCCESS = 200
- (nonstandard success response, see rfc876)
- SMTP_SYNTAX_ERROR_PARAMTER = 501
- Syntax error in parameters or arguments
- SMTP_SYSTEM_STATUS_OR_HELP = 211
- System status, or system help reply
- SMTP_TRANSACTION_FAILED = 554
- Transaction failed
- SMTP_USER_NOT_LOCAL = 551
- User not local;please try <forward-path>
- VERSION = 2
- Generelle Alvine-Version
Properties
- $hasAssociatedProperties : boolean
- $hash : string
- Eindeutige ID
- $hasVolatileProperties : boolean
- $properties : array
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
- 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.
- 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.
- 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.
- 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
Constants
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
SMTP_ACCESS_DENIED
Access denied (???a Sendmailism)
public
mixed
SMTP_ACCESS_DENIED
= 530
SMTP_ACTION_OK
Requested mail action okay, completed
public
mixed
SMTP_ACTION_OK
= 250
SMTP_AUTHENTICATION_ENCRYPTION_REQUIRED
Encryption required for requested authentication mechanism
public
mixed
SMTP_AUTHENTICATION_ENCRYPTION_REQUIRED
= 538
SMTP_AUTHENTICATION_IS_TO_WEAK
Authentication mechanism is to weak
public
mixed
SMTP_AUTHENTICATION_IS_TO_WEAK
= 534
SMTP_AUTHENTICATION_REQUIRED
Authentication required
public
mixed
SMTP_AUTHENTICATION_REQUIRED
= 530
SMTP_AUTHENTICATION_TEMPORARY_FAILURE
Temporary authentication failure
public
mixed
SMTP_AUTHENTICATION_TEMPORARY_FAILURE
= 454
SMTP_BAD_SEQUENCE
Bad sequence of commands
public
mixed
SMTP_BAD_SEQUENCE
= 503
SMTP_CANNOT_VERIFY_USER
Cannot VRFY user, but will accept message and attempt delivery
public
mixed
SMTP_CANNOT_VERIFY_USER
= 252
SMTP_COMMAND_UNRECOGNISED
Syntax error, command unrecognised
public
mixed
SMTP_COMMAND_UNRECOGNISED
= 500
SMTP_DOES_NOT_ACCEPT_MAIL
<domain> does not accept mail (see rfc1846)
public
mixed
SMTP_DOES_NOT_ACCEPT_MAIL
= 521
SMTP_EXCEEDED_STORAGE_ALLOCATION
Requested mail action aborted: exceeded storage allocation
public
mixed
SMTP_EXCEEDED_STORAGE_ALLOCATION
= 552
SMTP_FORWARD
User not local;will forward to <forward-path>
public
mixed
SMTP_FORWARD
= 251
SMTP_HELP_MESSAGE
Help message
public
mixed
SMTP_HELP_MESSAGE
= 214
SMTP_INSUFFICIENT_SYSTEM_STORAGE
Requested action not taken: insufficient system storage
public
mixed
SMTP_INSUFFICIENT_SYSTEM_STORAGE
= 452
SMTP_MAILBOX_NAME_NOT_ALLOWED
Requested action not taken: mailbox name not allowed
public
mixed
SMTP_MAILBOX_NAME_NOT_ALLOWED
= 553
SMTP_MAILBOX_PERMANENT_UNAVAILABLE
Requested action not taken: mailbox unavailable (hard / dauerhaft)
public
mixed
SMTP_MAILBOX_PERMANENT_UNAVAILABLE
= 550
SMTP_MAILBOX_UNAVAILABLE
Requested mail action not taken: mailbox unavailable (soft / temporäre)
public
mixed
SMTP_MAILBOX_UNAVAILABLE
= 450
SMTP_NOT_IMPLEMENTED
Command not implemented
public
mixed
SMTP_NOT_IMPLEMENTED
= 502
SMTP_PARAMETER_NOT_IMPLEMENTED
Command parameter not implemented
public
mixed
SMTP_PARAMETER_NOT_IMPLEMENTED
= 504
SMTP_REQUEST_ABORTED
Requested action aborted: local error in processing
public
mixed
SMTP_REQUEST_ABORTED
= 451
SMTP_SERVICE_CLOSING_TRANSMISSION
<domain> Service closing transmission channel
public
mixed
SMTP_SERVICE_CLOSING_TRANSMISSION
= 221
SMTP_SERVICE_NOT_AVAILABLE
<domain> Service not available, closing transmission channel
public
mixed
SMTP_SERVICE_NOT_AVAILABLE
= 421
SMTP_SERVICE_READY
<domain> Service ready
public
mixed
SMTP_SERVICE_READY
= 220
SMTP_START_MAIL
Start mail input;end with <CRLF>.<CRLF>
public
mixed
SMTP_START_MAIL
= 354
SMTP_SUCCESS
(nonstandard success response, see rfc876)
public
mixed
SMTP_SUCCESS
= 200
SMTP_SYNTAX_ERROR_PARAMTER
Syntax error in parameters or arguments
public
mixed
SMTP_SYNTAX_ERROR_PARAMTER
= 501
SMTP_SYSTEM_STATUS_OR_HELP
System status, or system help reply
public
mixed
SMTP_SYSTEM_STATUS_OR_HELP
= 211
SMTP_TRANSACTION_FAILED
Transaction failed
public
mixed
SMTP_TRANSACTION_FAILED
= 554
SMTP_USER_NOT_LOCAL
User not local;please try <forward-path>
public
mixed
SMTP_USER_NOT_LOCAL
= 551
VERSION
Generelle Alvine-Version
public
mixed
VERSION
= 2
Properties
$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.
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
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
Tags
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
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>
Tags
__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
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
Return values
AlvinegetClosure()
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
Return values
ClosuregetHashCode()
Die Methode Alvine::getID() verwenden!
public
getHashCode() : string
Tags
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
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
stringhasAssociatedProperties()
Check if the object has associative properties
public
hasAssociatedProperties() : boolean
Tags
Return values
booleanhasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
public
hasVolatileProperties() : boolean
Tags
Return values
booleanisCallable()
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
booleanpropertyExists()
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
booleancheckAndAdjustSerialisation()
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