Zend_Service_Delicious
Einführung
Zend_Service_Delicious ist eine simple API, um
die XML- und JSON-Webservices von » del.icio.us nutzen zu können. Diese Komponente
bietet Lese- und Schreibzugriff auf Beiträge bei del.icio.us, sofern man die nötigen
Zugrffisrechte vorweist.
Example #1 Alle Beiträge abrufen
span style="color: #ff0000;">'username', 'password'"--\n""Title: {$post->getTitle()}\n""Url: {$post->getUrl()}\n";
}
Beiträge abrufen
Zend_Service_Delicious bietet drei Möglichkeiten, um Beiträge von
del.icio.us abzurufen: getPosts(),
getRecentPosts() und getAllPosts().
Jede dieser Methoden liefert eine Instanz der Klasse
Zend_Service_Delicious_PostList, welche die abgerufenen Beiträge
beinhaltet.
/**
* Beiträge werden je nach Parametern geladen. Ist kein Datum oder
* kein URL gegeben, so wird standardmäßig das aktuelleste Datum
* verwendet.
*
* @param string $tag Optionaler Filter nach einem bestimmten tag
* @param Zend_Date $dt Optionaler Filter nach Datum
* @param string $url Optionaler Filter nach URL
* @return Zend_Service_Delicious_PostList
*//**
* Die letzten x Beiträge abrufen.
*
* @param string $tag Optionaler Filter nach einem bestimmten tag
* @param string $count Maximale Anzahl der Beiträge, die
* zurückgeliefert werden (standardmäßig 15)
* @return Zend_Service_Delicious_PostList
*//**
* Alle Beiträge abrufen
*
* @param string $tag Optionaler Filter nach einem bestimmten tag
* @return Zend_Service_Delicious_PostList
*/
Zend_Service_Delicious_PostList
Instanzen dieser Klasse werden von den Methoden getPosts(),
getAllPosts(), getRecentPosts() und
getUserPosts() der Klasse
Zend_Service_Delicious zurückgegeben.
Für den leichteren Zugriff implementiert diese Klasse die Interfaces
Countable , Iterator andArrayAccess .
Example #2 Zugriff auf Beitragslisten
span style="color: #ff0000;">'username', 'password'// Beiträge zählen
// Iteration über die Beitragsliste
"--\n""Title: {$post->getTitle()}\n""Url: {$post->getUrl()}\n";
}
// speziellen Beitrag über Arrayzugriff erhalten
Note:
Die Methoden ArrayAccess::offsetSet() und
ArrayAccess::offsetUnset() werfen in dieser Implementierung
Ausnahmen (Exceptions). Dadurch werfen Codes, wie z.B. unset($posts[0]);
oder $posts[0] = 'A'; Exceptions, da nur Leserechte für die Eigenschaften
bestehen.
Beitragslisten-Objekte haben zwei integrierte Filter-Möglichkenten. Die Listen können
nach Tags und nach URLs gefiltert werden.
Example #3 Eine Beitragsliste nach gewissen tags filtern
Beiträge mit speziellen tags können durch die Methode
withTags() aus der Liste herausgefiltert werden. Der
Einfachheit halber, kann die Methode withTag() verwendet
werden, wenn nur nach einem einzigen tag gefiltert werden soll.
span style="color: #ff0000;">'username', 'password'// Alle Beiträge ausgeben, denen die tags "php" und "zend" zugeordnet sind
'php', 'zend'"Title: {$post->getTitle()}\n""Url: {$post->getUrl()}\n";
}
Example #4 Eine Beitragsliste nach URLs filtern
Beiträge können mit Hilfe der Methode withUrl() nach einer
speziellen URL gefiltert werden indem ein passender regulärer
Ausdruck spezifiziert wird.
span style="color: #ff0000;">'username', 'password'// Beiträge ausgeben, deren URL "/help/" enthält
'/help/'"Title: {$post->getTitle()}\n""Url: {$post->getUrl()}\n";
}
Das Bearbeiten von Beiträgen
Example #5 Beiträge bearbeiten
span style="color: #ff0000;">'username', 'password'// Titel setzen
'New title');
// Änderungen speichern
Example #6 Verkettung von Methodenaufrufen
Jede set-Methode gibt das Beitragsobjekt zurück, so dass man die Methodenaufrufe
verketten kann.
span style="color: #ff0000;">'username', 'password''New title')
->setNotes('New notes')
->save();
Das Löschen von Beiträgen
Es existieren zwei Wege, um einen Beitrag zu löschen. Zum Einen explizit über den
Beitrags-URL oder zum Anderen durch den Aufruf der Methode
delete() mit dem Objekt, welches den zu löschenden Beitrag
repräsentiert.
Example #7 Beiträge löschen
span style="color: #ff0000;">'username', 'password');
// Explizites Löschen eines Beitrags über einen URL
'http://framework.zend.com');
// Löschen eines Beitrags über den Aufruf der delete()-Methode
// eine alternative Anwendung von deletePost()
Das Hinzufügen von neuen Beiträgen
Um einen Beitrag hinzuzufügen, muss zu Beginn die Methode
createNewPost() aufgerufen werden, welche eine Instanz der Klasse
Zend_Service_Delicious_Post zurückgibt. Danach kann mit Hilfe des
erhaltenen Objekts der Beitrag verändert werden. Nach der Änderung muss die
save()-Methode aufgerufen werden, damit die Änderungen in die
del.icio.us-Datenbank übernommen werden.
Example #8 Einen Beitrag hinzufügen
span style="color: #ff0000;">'username', 'password');
// Neuen Beitrag erstellen, ändern und abspeichern
// (Verkettung der Methodenaufrufe)
'Zend Framework', 'http://framework.zend.com')
->setNotes('Zend Framework Homepage')
->save();
// Neuen Beitrag erstellen, ändern und abspeichern (ohne Verkettung)
'Zend Framework',
'http://framework.zend.com''Zend Framework Homepage'
Bundles
span style="color: #ff0000;">'username', 'password');
// get all bundles
// delete bundle someBundle
'someBundle');
// add bundle
'newBundle''tag1', 'tag2'));
Öffentliche Daten
Die del.icio.us webservice API ermöglicht den Zugriff auf die
öffentlichen Daten aller Nutzer.
Methoden, um öffentliche Daten abzurufen
Name |
Beschreibung |
Rückgabewert |
getUserFans() |
Liefert die Fans eines Nutzers |
Array |
getUserNetwork() |
Liefert das Netzwerk eines Nutzers |
Array |
getUserPosts() |
Liefert alle Beiträge eines Nutzers |
Zend_Service_Delicious_PostList |
getUserTags() |
Liefert alle tags, die der Nutzer vergeben hat |
Array |
Note:
Sollten nur diese Methoden verwendet werden, ist dem Konstruktor der Klasse
Zend_Service_Delicious bei der Instanzierung kein Nutzername
in Kombination mit dem entsprechenden Passwort zu übergeben.
Example #11 öffentliche Daten auslesen
// Nutzername und Passwort werden nicht benötigt
// Laden der Fans eines Nutzers
'someUser'));
// Laden des Netzwerks eines Nutzers
'someUser'));
// Laden der vergebenen tags eines Nutzers
'someUser'));
Öffentliche Beiträge
Wenn öffentliche Beiträge über die Methode getUserPosts()
bezogen werden wird ein Zend_Service_Delicious_PostList
Objekt zurückgegeben, welches die einzelnen Beiträge in einer Liste von
Zend_Service_Delicious_SimplePost-Objekten speichert. Diese
Objekte enthalten Basisinformationen über den Beitrag, wie z.B. den
URL, den Titel, die Notizen und Tags.
Methoden der Klasse Zend_Service_Delicious_SimplePost
Name |
Beschreibung |
Rückgabewert |
getNotes() |
Liefert die Beschreibung zu einem Beitrag |
String |
getTags() |
Liefert die tags zu einem Beitrag |
Array |
getTitle() |
Liefert den Titel eines Beitrags |
String |
getUrl() |
Liefert den URL eines Beitrags |
String |
HTTP client
Zend_Service_Delicious verwendet die Klasse
Zend_Rest_Client, um HTTP-Request an den
del.icio.us Webservice zu schicken. Um einzustellen, welchen HTTP
Client Zend_Service_Delicious verwenden soll, muss der
HTTP Client der Klasse Zend_Rest_Client
geändert werden.
Example #12 Veränderung des HTTP clients der Klasse Zend_Rest_Client
Sollte man mehr als einen Request mit Zend_Service_Delicious
senden, ist es sinnvoll den HTTP Client so zu konfigurieren, dass die
Verbindungen offen gehalten werden, um die Geschwindigkeit der Requests zu erhöhen.
Example #13 Konifguration des HTTP clients, so dass Verbindungen geöffnet bleiben
span style="color: #ff0000;">'keepalive'
Note:
Bei der Instanzierung eines Zend_Service_Delicious Objekts
wird der SSL Transport der Klasse
Zend_Rest_Client auf 'ssl' anstatt auf
'ssl2' gesetzt, da del.icio.us einige Probleme mit 'ssl2'
hat. So kann es vorkommen, dass die Vervollständigung eines Request sehr lange (um
die zwei Sekunden) dauert.
|
|