Personen

OMC_Contact

Die Klasse OMC_Contact repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Kontaktpersonen. Die Instanzmethoden dieser Klasse sowie Sessions finden Sie weiter unten in diesem Dokument.

Klassenmethoden {: #contact_classmethods}

`OMC_Contact __construct([array $fields = array()])`
Aufgabe: Erstellt eine neue lokale Instanz einer Kontaktperson. Zugriff: `$neue_person = new OMC_Contact();` Rückgabewert: Die Instanz der Person. Exceptions: –

`OMC_Contact authenticate(string $login, string $password)`
Aufgabe: Meldet eine Person am OMC an. Rückgabewert: Die Instanz der Person. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_AuthenticationFailedException`

`OMC_Contact create([array $properties = array()])`
Aufgabe: Erstellt im OMC eine Person mit den angegebenen Feldern. Rückgabewert: Die Instanz der Person. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_Contact find(integer $scope, [array $params = array()])`
Aufgabe: Findet eine Person anhand der gegebenen ID (`$scope`) im OMC. Rückgabewert: Die Instanz der Person. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`OMC_Contact findByLogin(string $login)`
Aufgabe: Ermittelt eine Person anhand ihres Logins (veraltet, stattdessen `validateLogin($login)` verwenden). Rückgabewert: Die Instanz der Person. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array<String> languages()`
Aufgabe: Listet alle im OMC verfügbaren Sprachen als Array von Strings auf. Rückgabewert: Das Array der Sprachkürzel. Exceptions: `OMC_UnauthorizedAccessException`

`array<String> subscriptions()`
Aufgabe: Listet alle im OMC verfügbaren benannten manuellen Sammellisten (ehemals Abonnements) als Array von Strings auf. Rückgabewert: Das Array der Namen der benannten Sammellisten. Exceptions: `OMC_UnauthorizedAccessException`

`array<String> titles()`
Aufgabe: Listet alle im OMC verfügbaren Titel von Personen als Array von Strings auf. Rückgabewert: Das Array der Titel. Exceptions: `OMC_UnauthorizedAccessException`

`OMC_Contact validateLogin($login)`
Aufgabe: Sucht die Kontaktperson mit dem angegebenen eindeutigen Login. Rückgabewert: Die Instanz der Person. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

Instanzmethoden {: #contact_instancemethods}

`void changePassword(string $old, string $new)`
Aufgabe: Überprüft, ob das gegebene Passwort (`$old`) richtig ist und setzt danach das neue Passwort (`$new`) der Kontaktperson. Rückgabewert: – Exceptions: `OMC_UnauthorizedAccessException`, `OMC_AuthenticationFailedException`

`OMC_Diary createDiary(array $params)`
Aufgabe: Erstellt einen Tagebucheintrag für die Kontaktperson. Rückgabewert: Die Instanz des Tagebucheintrages. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_Inquiry createInquiry(array $params)`
Aufgabe: Erstellt eine Anfrage für die Kontaktperson. Rückgabewert: Die Instanz der Anfrage. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_Location createLocation(params $params)`
Aufgabe: Fügt zu dem Account, zu dem die Kontaktperson gehört, einen Standort hinzu und weist der Kontaktperson diesen Standort zu. Rückgabewert: Die Instanz des Standorts. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_Inquiry createRegistrationRequest(array $attributes)`
Aufgabe: Erstellt im OMC eine Anfrage, die die Felder dieser Kontaktperson beinhaltet. Rufen Sie diese Methode am besten auf einer lokalen Instanz einer Person auf, die noch nicht gesichert wurde (z.B. mit `save()`) und auch nicht gesichert werden sollte, da die Daten der Person erst (von einem OMC-Anwender) überprüft werden sollten. Rückgabewert: Die Instanz der Anfrage Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

OMC_Inquiry createRegistrationRequest(array $attributes)

Aufgabe: Erstellt im OMC eine Anfrage, die die Felder dieser Kontaktperson beinhaltet. Rufen Sie diese Methode am besten auf einer lokalen Instanz einer Person auf, die noch nicht gesichert wurde (z.B. mit save()) und auch nicht gesichert werden sollte, da die Daten der Person erst (von einem OMC-Anwender) überprüft werden sollten.
Rückgabewert: Die Instanz der Anfrage
Exceptions: OMC_UnauthorizedAccessException, OMC_ResourceInvalidException

`OMC_EventContact eventParticipation(integer $eventId)`
Aufgabe: Liest die Event-Teilnehmerdaten der Kontaktperson aus. Rückgabewert: Die Instanz der Event-Teilnehmerdaten. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`OMC_Inquiry findInquiry(integer $inquiryId)`
Aufgabe: Findet die Anfrage, wenn die Anfrage mit dieser Kontaktperson verknüpft ist. Rückgabewert: Die Instanz der Anfrage Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`void generatePassword([array $emailOptions = array()])`
Aufgabe: Erstellt ein zufälliges neues Passwort für die Kontaktperson und schickt der Person eine E-Mail mit diesem Passwort. Rückgabewert: – Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_Account getAccount()`
Aufgabe: Liest den zur Kontaktperson gehörenden Account aus. Zugriff: `$kontakt_person->account` Rückgabewert: Die Instanz des Accounts. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array<OMC_Inquiry> getAccountInquiries()`
Aufgabe: Listet alle Anfragen auf, die zu dem Account der Kontaktperson gehören. Zugriff: `$kontakt_person->accountInquiries` Rückgabewert: Ein Array von Instanzen der Anfragen Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array getFields()`
Aufgabe: Listet alle nicht-leeren Felder dieser Person auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –

`array<OMC_Inquiry> getInquiries()`
Aufgabe: Listet alle Anfragen auf, die zu der Kontaktperson gehören. Zugriff: `$kontakt_person->inquiries` Rückgabewert: Ein Array von Instanzen der Anfragen Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`OMC_Location getLocation()`
Aufgabe: Liest den Standort der Kontaktperson aus. Zugriff: `$kontakt_person->location` Rückgabewert: Die Instanz des Standorts. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array<OMC_Location> getLocations()`
Aufgabe: Listet alle Standorte des Accounts auf, zu dem die Kontaktperson gehört. Zugriff: `$kontakt_person->locations` Rückgabewert: Ein Array von Instanzen der Standorte Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array<String> getRoles()`
Aufgabe: Listet alle Rollen auf, die die Kontaktperson hat. Zugriff: `$kontakt_person->roles` Rückgabewert: Ein Array von Strings Exceptions: –

`array<String> getSubscriptions()`
Aufgabe: Listet alle manuellen benannten Sammellisten auf, in die die Kontaktperson eingetragen ist. Zugriff: `$kontakt_person->subscriptions` Rückgabewert: Ein Array von Strings Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`boolean isNewRecord()`
Aufgabe: Überprüft, ob diese Person bereits im OMC existiert. Rückgabewert: `true`, wenn es sich um eine bisher noch nicht gespeicherte Kontaktperson handelt. Exceptions: –

`boolean moveLocation(integer $locationId)`
Aufgabe: Weist dieser Kontaktperson einen neuen Standort zu. Rückgabewert: Die Methode meldet `false`, falls die `$locationId` nicht existiert oder diese nicht zum betreffenden Account gehört. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`boolean save()`
Aufgabe: Speichert die lokalen Änderungen dieser Person im OMC, oder erstellt eine neue Kontaktperson. Rückgabewert: Meldet, ob das Speichern erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`boolean updateAttributes(array $attributes)`
Aufgabe: Ändert die Felder dieser Kontaktperson und speichert sie im OMC. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`void updateFields(array $fields)`
Aufgabe: Überschreibt die angegebenen Felder aus `$fields` der Person lokal. Felder, die diese Person hat, die jedoch nicht in `$fields` angegeben sind, werden nicht gelöscht oder überschrieben. Rückgabewert: – Exceptions: –

`void updateSubscriptions(array $names)`
Aufgabe: Überschreibt die Liste der benannten manuellen Sammellisten, in der diese Kontaktperson enthalten ist. Falls eine ungültige Sammelliste angegeben wurde (z.B. wenn diese im OMC nicht verfügbar ist), dann wird diese ignoriert. Rückgabewert: – Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

OMC_Session {: #session_classmethods}

Die Klasse OMC_Session repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Single-sign-on-Sessions. Die Instanzmethoden dieser Klasse finden Sie weiter unten in diesem Dokument.

Klassenmethoden

`void discardWithToken(string $token)`
Aufgabe: Invalidiert eine Single-sign-on-Session im OMC, die durch das gegebene (`$token`) identifiziert wird. Rückgabewert: – Exceptions: `OMC_UnauthorizedAccessException`, `OMC_AuthenticationFailedException`

`OMC_Session establish(string $login, string $password)`
Aufgabe: Stellt eine Single-sign-on-Session für eine Person her. Anschließend ist das Feld `token` vorhanden. Beispiel: `$token = OMC_Session::establish('user', 'passwort')->token;` Rückgabewert: Die Instanz der Session. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_AuthenticationFailedException`

`OMC_Session establishWithToken(string $token)`
Aufgabe: Überprüft, ob das (`$token`) für die Single-sign-on-Session noch aktiv ist und verlängert diese, wenn dies zutrifft. Danach muss das Token neu ausgelesen werden. Beispiel: `$neuer_token = OMC_Session::establishWithToken($alter_token)->token;` Rückgabewert: Die Instanz der Session. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_AuthenticationFailedException`

Instanzmethoden {: #session_instancemethods}

`void discard()`
Aufgabe: Invalidiert diese Single-sign-on-Session im OMC. Rückgabewert: – Exceptions: `OMC_UnauthorizedAccessException`, `OMC_AuthenticationFailedException`

`OMC_Contact getContact()`
Aufgabe: Liest die zur Session gehörende Kontaktperson aus. Zugriff: `$session->contact` Rückgabewert: Die Instanz der Kontaktperson. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array getFields()`
Aufgabe: Listet alle nicht leeren Felder dieser Session auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –

`OMC_Session renew()`
Aufgabe: Erneuert diese Single-sign-on-Session, damit sie länger verfügbar ist. Rückgabewert: Die Instanz dieser Session. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_AuthenticationFailedException`