Zu Handbuch PHP-API

Voraussetzungen, Installation und Einbindung der PHP-API

Voraussetzungen für die PHP-API

Damit Sie die PHP-API in eigenen Skripten verwenden können, müssen folgende Voraussetzungen erfüllt sein:

  • PHP 5.2
  • Innerhalb von PHP muss die cURL-Extension zur Verfügung stehen
  • Der Webserver muss auf api.golem.de zugreifen können.

Installation

Die Installation beschränkt sich im Wesentlichen darauf, die API-Paketdatei herunter zu laden, zu entpacken und die benötigten Dateien an den gewünschten Ort zu kopieren.

Download

Eine Liste der zum Download verfügbaren Versionen finden Sie unter http://api.golem.de/download/.

Die jeweils aktuelle Version finden Sie zum Download unter http://api.golem.de/download/php/latest/Golem_PHP.zip.

Entpacken

Entpacken Sie das Archiv an die gewünschte Stelle. Das Archiv besteht aus den folgenden Verzeichnissen:

  • doc enthält die Referenz-Dokumentation der PHP-API
  • Golem enthält die Quellcode-Dateien der PHP-API
  • tests enthält die PHPUnit-Tests der PHP-API

Um die PHP-API zu nutzen, benötigen Sie lediglich das Verzeichnis Golem.

Einbindung

Basis-Dateien

Sie müssen grundsätzlich die jeweils benötigten Dateien der PHP-API einbinden. Unabhängig davon, welchen Teil der API Sie benötigen, ist eine Dateien stets erforderlich:

  • Golem/Request.php aus der Golem.de PHP-API

Spezifische Klassendateien

Wenn Sie eine bestimmte Klasse der PHP-API benötigen, so müssen Sie die Datei einbinden, in welcher die Klasse definiert ist. Jede Klasse ist in einer eigenen Datei definiert. Den Pfad und den Namen der Datei können Sie aus dem Klassennamen ableiten. Dazu ersetzen Sie im Klassennamen alle Unterstriche durch Schrägstriche und hängen die Dateiendung .php an.

Beispiel: Die Klasse Golem_Api_Article_Search ist definiert in der Datei Golem/Api/Article/Search.php



Zu Handbuch PHP-API