Zu Handbuch PHP-API

Golem_Api_Article_Images – Bilder zu einem Artikel holen

Mit der Klasse Golem_Api_Article_Images laden Sie die Liste der Bilder, die zu einem Artikel gehören.

Einbindung

require_once '[Installationsort/]Golem/Request.php';
require_once '[Installationsort/]Golem/Api/Article/Images.php';

Verwendung

Um ein neues Objekt der Klasse Golem_Api_Article_Images zu erzeugen, übergeben Sie dem Konstruktor Ihren Entwicklerschlüssel und den Identifier des Artikels:

$request = new Golem_Api_Article_Images($developerKey, 12345);
Beispiel 1: Objektinitialisierung

Die eigentliche Abfrage erfolgt mit der Methode fetch(). War der Aufruf der Methode erfolgreich, erhalten Sie die Bildinformationen entweder über getImages() oder direkt über das $request-Objekt. Die Methode getImages() liefert ein Array zurück, jeder Eintrag des Arrays enthält die Daten eines Bildes.

$request->fetch();

$images = $request->getImages();
Beispiel 2: Abfrage starten und Daten holen

Golem_Api_Article_Images implementiert das Iterator- und Countable-Interface. Das heißt, wenn die Datenabfrage erfolgreich, können Sie $request direkt mit count() und foreach() verwenden, um die Anzahl der Bilder zu ermitteln und auf die Bildeinträge zu zugreifen.

$request->fetch();

echo "Anzahl der Bilder: ".count($request);

foreach($request as $image) {

    echo $image['subtext'];

}
Beispiel 3: Zugriff mit foreach() und count()

Fehlerbehandlung

Während der Datenabfrage können Fehler auftreten:

  • Golem_Api_Article_Images::ERROR_INVALID_IDENTIFIER bedeutet, dass der übergebene Artikel-Identifier falsch ist, oder kein entsprechender Artikel existiert.

Wenn während der Abfrage ein Fehler auftritt, wird eine Exception geworfen, die Sie mit try-catch auffangen können.

try {

 $request->fetch();

 $images = $request->getImages();

} catch(Exception $e) {

 switch($e->getErrorCode()) {

  case Golem_Api_Article_latest::ERROR_INVALID_IDENTIFIER :
       ...
       break;
  case ...

 }

}
Beispiel 4: Fehler abfangen

Verfügbare Bilddaten

Jeder Bildeintrag besitzt folgende Eigenschaften:

Name Bedeutung
imageid Bild-Identifier
subtext Der Text zum Bild
small Ein assoziatives Array mit den Daten des Bildes in der Thumbnail-Version. Die Einträge des Arrays sind:
  • url – Die URL des Bildes
  • width – Die Breite des Bildes in Pixel
  • height – Die Höhe des Bildes in Pixel
medium Ein assoziatives Array mit den Daten des Bildes in einer mittelgroßen Version. Die Einträge des Arrays sind:
  • url – Die URL des Bildes
  • width – Die Breite des Bildes in Pixel
  • height – Die Höhe des Bildes in Pixel
native Ein assoziatives Array mit den Daten des Bildes in der Originalversion. Die Einträge des Arrays sind:
  • url – Die URL des Bildes
  • width – Die Breite des Bildes in Pixel
  • height – Die Höhe des Bildes in Pixel



Zu Handbuch PHP-API