Często odbywają się dyskusje dotyczące formatu w jakim przechowywać konfiguracja aplikacji. Najczęściej wybierane sposoby to pliki INI, YAML oraz XML. Za najlepsze rozwiązanie uważam wykorzystanie XML’a.
Główną zaletą XML jest jego popularność oraz szereg standartów które znacznie usprawniają prace. Struktury XML są bardzo łatwo rozszerzalne poprzez XInclude. Walidację takiego pliku można bardzo szybko rozwiązać tworząc plik XSD, natomiast jeżeli potrzebujemy ładnej prezentacji zawartości, wystarczy stworzyć plik XSLT oraz napisać kilkadziesiąt linijek.
XPath jest językiem używanym do lokalizacji oraz pozyskiwania informacji z drzewa XML. Język ten jest również potrzebny podczas używania XPointer oraz XSLT
Do przetwarzania XML’a będziemy używać rozszerzenia DOM dla PHP.
Zacznijmy od podstawowego wyrażenia xpath. Pobierzemy wszystkie nazwiska z naszej książki adresowej:
Do wykonywania operacji korzystając z XPath służy klasa DOMXPath. Tworząc egzemplarz tej klasy przekazujemy obiekt DOM na którym chcemy operować, następnie używając metody query która zwraca to o co prosiliśmy.
A o co prosiliśmy i jak prosić? W przykładzie powyżej napisaliśmy bardzo proste wyrażenie, które zwróciło nam tylko nazwiska (lastname) osób w książce. Poszczególne poziomy w dokumencie XML oddzielane są znakiem /. Jezeli zapytanie zaczyna się od slasha oznacza to że wyszukiwanie ma zacząć się od najwyższego elementu.
Używając XPath możemy pisać bardziej szczególowe zapytania. Wybrać nazwisko osoby o numerze id równym 1:
Dodający przy person nawias kwadratowy ograniczyliśmy wyszukiwanie tylko do elementów person które posiadają atrybut id o wartości równej 1. Znak @ przed id oznacza że uwzględniamy atrybuty nie elementy.
Powyższe zapytanie zwróci nam nazwiska osób których imię to Paweł oraz miejsce zamieszkania to Warszawa. W tym zapytanie nie używaliśmy znaku @ ponieważ interesowały nas elementy a nie atyrbuy.
Przedstawiłem tutaj podstawowe sposoby które najczęściej są używane podczas korzystanie z XPath. Po więcej informacji zapraszam do dokumentacji XPath.
XPointer jest rozszerzeniem XPath i używa jego składni. Jest to język do adresowania fragmentów dokumentów XML. Został przewidziany do stosowania w adresach URI.
Przykładowe wyrażenia XPath używając XPointer wyglądają następująco:
Wspomniałem o używaniu w adresach URI. Tak przykładowo by wyglądało wyrażenie jako fragment URI:
XInclude jest standartem który pozwala nam dołączać zewnętrzne dokumenty lub ich fragmnety do pliku XML. XInclude zawiera się w przestrzeni nazw http://www.w3.org/2001/XInclude. W tym namespace mamy dwa elementy zakładając że zadeklarujemy prefix xi będzie to xi:include oraz xi:fallback. Pierwszy z nich określa lokalizacje jednostki którą chcemy dołączyć - może być to mały zakres XML’a wybrany XPath’em lub cały plik. Może się zdarzyć że XInclude zwróci błąd. Plik lub wybrany zakres który chcemy dołączyć może nie istnieć. Aby osłużyć błąd XInclude oferuje element xi:fallback.
Rozszerzmy naszą książkę adresową o grupy. Mając wiele konkatków w pewnym momencie dobrze by było je jakoś uporządkować.
Nie trudno zauważyć że takie rozwiązanie jest kłopotliwe. Gdy ktoś zmieni numer będziemy musieli zmieniać ten numer w kilku miejscach.
Problem ten możemy rozwiązać właśnie dzięki XInclude. Zamiast posiadać te same wpisy kilka razy, będzie je dołączać na podstawie numeru ID.
Przetwórzmy teraz ten plik używając PHP i DOM:
Za XInclude w klasie odpowiedzialna jest metoda xinclude(). Na końcu zapisaliśmy zawartość w nowym pliku żeby móc sprawdzić czy to rzeczywiście działa. Otwierając plik powinniśmy zobaczyć zamiast wpisów xi:include, dołączone właściwe watrości.
Nasza książka może się rozrosnąć a trzymanie wszystkiego w jednym pliku może stać się nie wygodne. A co gdybyśmy chcieli trzymać grupy kontaktów w odzielnym pliku, np.: address-book-groups.xml?
Zawartość pliku wyglądała by wtedy następująco:
Wycieliśmy element groups wraz z jego dziećmi z pliku address-book.xml, dodając przy wartościach dołączanych atrybut href, wskazujący na plik w którym znajduje się nasz XML z osobami.
Format XML jest dość czytelnym formatem jednak nie nadaje się on do prezentacji. Zdecydowanie lepszym pomysłem jest wyświetlić dane osadzając je ładnie np.: w HTMLu. Mamy do wyboru dwie drogi: pierwsza użycie DOM w PHP, parsując dokument i wyświetlając go wg. naszych oczekiwań. Drugim, lepszym sposobem, jest stworzenie pliku XSL oraz wykonać transformację przy użyciu XSLT.
Pliki XSL są dokumentami opisującymi sposób prezentacji i przekształceń dokumentów XML. Spróbujemy teraz pisząc kilka prostych podstawowych instrukcji, przekształcić XML naszej książki aby była ona prezentowana w formie tabeli HTML.
Jako że nasz plik jest dość prosty to w również prosty sposób zaprezentujemy go w tabeli html, przy okazji sortując
Plik zaczynami od przypisania prefixu dla przestrzeni nazw XSL. Następie posługujemy się elementem xsl:template który definiuje szablon. Nasz szablon zaczyna się od podstawowych elementów html. Aby przetworzyć każdą osobę posłużymy się elementem xsl:for-each, w atrybucie select zaznaczając zbiór węzów do przetworznia używając wyrażeń XPath. Następnie zaznaczamy że chceby aby osoby były posortowane alfabetycznie wg. nazwiska i umieszczamy szablon który ma być używany przy każdym elemencie który ma być przetworzony. Zawiera on html wiersza tabeli. W komórkach tabeli do wyświetlenia imienia i nazwiska osoby użwywamy elementu xsl:value-of który zwraca wartość węzła podanego w atrybucie select. Trzeba zwrócić uwagę na to że podajemy tam wyrażenie XPath węzła który jest dostarczany przez xsl:for-each. W naszym przypadku będzie to np.:
Dlatego też atrybut select będzie zawierał wyrażenie firstname/ a nie jak niektóry mogli mylnie sądzić address-book/persons/person/firstname. Na końcu dodajmy w pliku naszej książki linijkę podpinającą plik XSL:
Gdy otworzymy teraz plik XML naszej książki w przeglądarce naszym oczom ukaże się tabelka z osobami a nie drzewo z XML’em.
W tym przypadku processorem XSLT był silnik przeglądarki. Jednak możemy zrobić to samo używając PHP i DOM’a.