Scriptorama.nl

Net zoals zovelen heb ook ik een account bij Flickr voor foto's die ik zo af en toe maak. Aangezien Flickr zo ongeveer het poster-child voor alles web2.0 is, is het alleen uploaden van foto's naar Flickr eigenlijk not-done.

Dus in dit artikeltje kijken we naar hoe we de RSS feeds van Flickr kunnen gebruiken om onze eigen Flickr overzicht te maken voor op bijv. je persoonlijke blog. Hiervoor zullen we PHP5's SimpleXML gebruiken.

Een van de dingen die werd aangepakt voor PHP 5 was het verwerken van XML. In PHP4 had je hier al twee methodes voor (SAX parsing en DOM parsing) maar deze waren ofwel enigzins ingewikkeld of gewoon niet zo stabiel. Voor PHP5 werd daarom de SimpleXML extensie in het leven geroepen.

Zoals je van de naam SimpleXML mag verwachten is het verwerken van XML met deze extensie behoorlijk eenvoudig. Om een XML bestand in te laden gebruiken we slechts één functie: simplexml_load_file. Deze functie geeft een object terug welke we kunnen gebruiken om het document verder te verwerken:

De individuele XML elementen kunnen we vervolgens benaderen als eigenschappen van het $xmlObj object. Neem bijvoorbeeld deze voorbeeld RSS file:

Om de titel van het eerste item te lezen gebruik je simpelweg:

Zoals je ziet slaan we het eerste element van het XML document, het zogenaamde document element, over. Dit komt omdat $xmlObj in feite al de verwijzing naar het eerste element is. Later zullen we zien hoe je de details van het document element kunt uitlezen.

Vervolgens benaderen we het channel element en daarin het item element. Zoals je ziet corresponderen deze namen exact met de XML element namen in de RSS feed. Er is maar een ding speciaal en dat is $xmlObj->channel->item. Deze ontstaat doordat er meerdere item elementen op hetzelfde niveau staan. Je kunt de individuele item element benaderen door simpel wel door $xmlObj->channel->item te lopen.

Met SimpleXML kunnen we dus met een paar regels een RSS feed verwerken:

Maar, we hebben het hier over een Flickr RSS feed en dus moeten we wel de foto's die in deze RSS feed staan gebruiken. Om de foto's beschikbaar te maken gebruikt Flickr de Media RSS uitbreiding en om deze te verwerken zullen we het nog iets anders moeten aan pakken.

De Media RSS namespace in Flickr RSS feeds

De Media RSS specificatie is een door Yahoo! ontwikkelde toevoeging op de RSS standaard waarbij media, zoals fotos en video's, duidelijk beschreven kunnen worden toegevoegd aan een RSS feed.

In de Flickr RSS feed ziet dat er als volgt uit. Het voorbeeld is ingekort om het duidelijk te houden:

In het document element worden de namespaces media en dc gedefinieerd. In dit geval gaat het ons alleen om de media namespace. In het eerste item element zie je vervolgens enkele elementen waarvan de naam begint met media:. Dit zijn elementen uit de Media RSS namespace.

In ons voorbeeld zullen we een lijst van thumbnails tonen. In dit geval hebben we dus interesse in het <media:thumbnail /> element. Om deze te kunnen benaderen zullen we een trucje moeten uithalen want in PHP kunnen object eigenschappen eigenlijk geen dubbele punt in hun naam hebben.

Om namespace elementen te verwerken gebruiken we de children methode en aan deze methode geven we de namespace waaruit we graag de children willen hebben. Om alle media RSS children te krijgen schrijven we dan:

Als namespace identifier geven we de URL op die bij de media namespace staat gedeclareerd in het document element. Deze aanroep geeft een object met alle elementen onder het item element die in de media namespace zitten. Deze elementen zijn weer te benaderen als object eigenschappen.

Zoals gezegd zijn wij nu voornamelijk geinteresseerd in het media:thumbnail element en specifiek daaruit willen we graag de URL weten. Hiervoor gebruiken we nog een andere methode: SimpleXMLElement::attributes().

Deze methode geeft ons alle attributen van het huidige xml element in een handige associatieve array. Dus om alle thumbnails weer te geven schrijven we:

Het is belangrijk om je te realiseren dat $thumbnailAttr['url'] nu wel als string gebruikt wordt, maar dat de waarde ervan eigenlijk een SimpleXMLElement instantie is. Doordat $thumbnailAttr['url'] in een echo statement gebruikt wordt, roept PHP intern direct de magic method __toString() aan op het object waardoor we toch het gewenste effect krijgen.

Om de waarde toch als string in handen te krijgen zul je $thumbnailAttr['url'] moeten casten naar een string:

Controleren of een XML document wel een RSS feed is

Eerder in dit artikel schreef ik dat het eerst element van een XML feed, het document element, niet wordt opgenomen als apart object eigenschap. Maar in sommige gevallen wil je toch graag dit document element benaderen, in ons geval bijvoorbeeld om te bepalen of het XML document wel een RSS feed is.

Hiervoor kun je het $xmlObj object direct aanspreken:

Maar dat is natuurlijk nog niet alles. We willen ook weten of deze RSS feed wel de Media RSS extensie gebruikt. Om dit te doen moeten we controleren of de Media RSS namespace definieert wordt in het document element en dit kunnen we doen met de methode getDocNamespaces():

Het volledige script

Ter volledigheid nog even een compleet script, inclusief controle of het document wel een RSS feed is:

Conclusie

Met SimpleXML zijn XML documenten erg simpel te verwerken. Zelfs als het document in kwestie gebruik maakt van wat geavanceerdere features, zoals bijvoorbeeld XML namespaces.

Een grappig demo-tje vind je hier. Deze moet bekeken worden met een recente WebKit nightly, aangezien deze CSS Transforms, een nieuwe webkit specifieke feature bevat. Of, als je daar geen zin in hebt, kun je ook gewoon dit screenshot bekijken:

Happy parsing!