OMC_Location
Die Klasse OMC_Location repräsentiert im OMC Connector (PHP)
die im Online Marketing Cockpit gespeicherten Standorte. Die Instanzmethoden
dieser Klasse finden Sie weiter unten in diesem Dokument.
Klassenmethoden
OMC_Location __construct([array $fields = array()]) |
|---|
Aufgabe: Erstellt eine neue lokale Instanz eines Standorts.
Zugriff: $neuer_standort = new OMC_Location();
Rückgabewert: Die Instanz des Standorts.
Exceptions: –
|
OMC_Location create([array $properties = array()]) |
|---|
Aufgabe: Erstellt im OMC einen Standort mit den angegebenen Feldern.
Rückgabewert: Die Instanz des Standorts.
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceInvalidException
|
OMC_Location find(integer $scope, [array $params = array()]) |
|---|
Aufgabe: Findet einen Standort anhand der
gegebenen ID ($scope) im OMC.
Rückgabewert: Die Instanz des Standorts.
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceNotFoundException
|
array<OMC_Location> findAllWithFilter($filter) |
|---|
Aufgabe: Listet alle Standorte im OMC auf, die den
Kriterien aus ($filter) genügen.
Beispiel (Filter): array("collection_id" => 3) oder array("per_page" => 3, "page" => 1)
Rückgabewert: Ein Array mit Instanzen von Standorten.
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceNotFoundException,
OMC_ResourceInvalidException
|
array<OMC_Location> findAllWithinDistanceFromCoordinates(integer $distance, string $latitude, string $longitude, [array $params = array()]) |
|---|
Aufgabe: Listet alle Standorte im OMC auf, die im Umkreis von
$distance Kilometern des Ortes mit den Koordinaten
$latitude und $longitude liegen.
Rückgabewert: Ein Array mit Instanzen von Standorten.
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceNotFoundException,
OMC_ResourceInvalidException
|
Instanzmethoden
array<OMC_Location> findAllWithinDistance(integer $distance, [array $params = array()]) |
|---|
Aufgabe: Listet alle Standorte im OMC auf, die im Umkreis von
$distance Kilometern dieses Standorts liegen.
Rückgabewert: Ein Array mit Instanzen von Standorten
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceNotFoundException,
OMC_ResourceInvalidException
|
OMC_Account getAccount() |
|---|
Aufgabe: Liest den zum Standort gehörenden Account aus.
Zugriff: $standort->account
Rückgabewert: Die Instanz des Accounts.
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceNotFoundException
|
array getFields() |
|---|
Aufgabe: Listet alle nicht leeren Felder dieses Standorts auf.
Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs
(String, Integer, Boolean usw.)
Exceptions: –
|
boolean isNewRecord() |
|---|
Aufgabe: Überprüft, ob dieser Standort bereits im OMC existiert.
Rückgabewert: true, wenn es sich um einen bisher
noch nicht gespeicherten Standort handelt.
Exceptions: –
|
boolean save() |
|---|
Aufgabe: Speichert die lokalen Änderungen dieses Standorts im OMC,
oder erstellt einen neuen Standort.
Rückgabewert: Meldet, ob das Speichern erfolgreich war.
Exceptions: OMC_UnauthorizedAccessException,
OMC_ResourceInvalidException
|
boolean updateAttributes(array $attributes) |
|---|
Aufgabe: Ändert die Felder dieses Standorts 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 des Standorts lokal. Felder, die dieser Standort
hat, die jedoch nicht in $fields angegeben sind, werden
nicht gelöscht oder überschrieben.
Rückgabewert: –
Exceptions: –
|
