Events

OMC_Event

Die Klasse OMC_Event repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Veranstaltungen. Die Instanzmethoden dieser Klasse und die Methoden von Veranstaltungsteilnehmern und Veranstaltungsteilnehmerdetails finden Sie weiter unten in diesem Dokument.

Klassenmethoden

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

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

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

`array<OMC_Event> findAllWithFilter(array $filter)`
Aufgabe: Listet alle Veranstaltung im OMC auf, die den Kriterien aus (`$filter`) entsprechen. Beispiel: `$offene_und_geschlossene_veranstaltungen = OMC_Event::findAllWithFilter(array("include_closed" => true));` Rückgabewert: Ein Array mit Instanzen von Veranstaltungen. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

`OMC_Event findByName(string $name)`
Aufgabe: Findet die Veranstaltung, die den Namen `$name` hat. Rückgabewert: Die Instanz der Veranstaltung. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

Instanzmethoden

`array<OMC_EventContact> getContacts()`
Aufgabe: Listet alle Veranstaltungsteilnehmer auf. Zugriff: `$veranstaltung->contacts` Rückgabewert: Ein Array von Instanzen der Veranstaltungsteilnehmer. 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: –

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

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

`boolean updateAttributes(array $attributes)`
Aufgabe: Ändert die Felder dieser Veranstaltung 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 Veranstaltung lokal. Felder, die diese Veranstaltung hat, die jedoch nicht in `$fields` angegeben sind, werden nicht gelöscht oder überschrieben. Rückgabewert: – Exceptions: –

OMC_EventContact

Die Klasse OMC_EventContact repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Veranstaltungsteilnehmer.

Instanzmethoden

`boolean attend([array $details = array()], [boolean $replace = false])`
Aufgabe: Übermittelt dem OMC, dass diese Person an der Veranstaltung teilnehmen will. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

`OMC_Details getDetails()`
Aufgabe: Liest die Details dieses Veranstaltungsteilnehmers aus. Zugriff: `$veranstaltungsteilnehmer->details` Rückgabewert: Die Details dieses Objekts. Exceptions: –

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

`boolean refuse([array $details = array()], [boolean $replace = false])`
Aufgabe: Übermittelt dem OMC, dass diese Person nicht an der Veranstaltung teilnehmen will. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

`boolean register([array $details = array()], [boolean $replace = false])`
Aufgabe: Übermittelt dem OMC, dass diese Person sich für die Veranstaltung anmelden will. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

`boolean updateDetails(array $details)`
Aufgabe: Aktualisiert die Details dieses Veranstaltungsteilnehmers im OMC. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

OMC_Details

Die Klasse OMC_Details dient dem Zweck, auf die Felder von OMC_EventContact leichter zugreifen zu können. Beispiel: $veranstaltungsteilnehmer->details->arrival_date

Instanzmethoden

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