Kategorie: IT

Etwas abstrakt bleibt es doch noch. Es gibt im Projekt zwei Arten von Elementen: Die einen enthalten andere Elemente, andere enthalten Text. Daher wird es zwei unterschiedliche Arten geben, wie zum einen getContent() funktioniert, und wie der Inhalt der Instanz hinzugefügt wird.

Zwei weitere abstrakte Klassen bieten sich da an, die die entsprechenden Methoden implementieren.

ALeo_Sitemap_Xml_StringContent

1. <?php
2. /*
3. Wird von Elementen erweitert, die nur eine
4. Zeichenkette als Inhalt haben.
6. Author: Hermann J. Leopold
7. Email: hermann.leopold@leopoldnet.de
8. Date: 2017-02-10
9. /*
11. require_once('ALeo_Sitemap_Xml.php');
13. abstract class ALeo_Sitemap_Xml_StringContent extends ALeo_Sitemap_Xml
14. {
15. // Darum geht es: Die Zeichenkette
16. private $_sContent;
18. /*
19. Hier wird der Inhalt übergeben.
20. /*
21. public function setStringContent($sString)
22. {
24. /* Generell dienen die Ausnahmefehler dazu,
25. Programmfehler zu vermeiden.
26. /*
28. // NULL ist nicht erlaubt.
29. if (is_null($sString)) {
31. throw new InvalidArgumentException("NULL statt Zeichenkette");
33. }
35. // Der Typ muss String sein,
36. // oder konvertierbar sein.
37. if (!is_string($sString)) {
39. throw new InvalidArgumentException("Keine Zeichenkette (aka String)");
41. }
43. // Alles OK
44. $this->_sContent = $sString;
46. }
48. /*
49. Und hier wird der Inhalt wieder zurück
50. gegeben.
51. /*
52. protected function getContent()
53. {
55. if (is_null ($this->_sContent)) {
57. $this->_sContent = '';
59. }
61. // Damit nichts passiert, werden Zeichen, die
62. // XML verwendet, umgewandelt.
63. return html_entity_decode($this->_sContent, ENT_XML1);
65. }
67. }

ALeo_Sitemap_Xml_StringContent.php

Da ich versuche, den Code vernünftig im Blog darzustellen, dürfen die Codezeilen nicht zu breit werden. Auch soll der Code gut lesbar sein; daher sind einige Details etwas umständlich geraten.

ILeo_Sitemap_Page

Bei den Daten der einzelnen Seiten habe ich wie besprochen auf die Elemente „changefreq“ und „priority“ verzichtet. Dafür können so viele Bilder wie gewünscht hinzugefügt werden.

1. <?php
2. /*
3. Deklariert Methoden und Konstanten für einen
4. Seiteneintrag der sitemap.xml
6. Author: Hermann J. Leopold
7. Email: hermann.leopold@leopoldnet.de
8. Date: 2017-02-01
10. /*
11. interface ILeo_Sitemap_Page
12. {
13. // Symbol des Url-Elements:
14. const csUrlSymbol = "url";
16. // Symbol für das Location-Elements
17. const csLocationSymbol = "loc";
19. // Symbol für das Zuletzt-geändert-Element
20. const csLastModSymbol = "lastmod";
22. // Hinzufügen der Bilder
23. // Was ein Bild ausmacht, wird in der
24. // ILeo_Sitemap_Image festgelegt.
25. function addImage(ILeo_Sitemap_Image $oImage);
27. // URL der Seite angeben.
28. function setLocation($sUrl);
30. // Datum der letzten Änderung angeben.
31. function setLastMod($sLastMod);
32. }

ILeo_Sitemap_Image

Die wichtigste Neuerung zum alten Plugin sitzt hier. Für jedes Bild können mehrere Texte hinterlegt werden. Die Möglichkeit, einen Link zur Lizenz zu hinterlegen habe ich behalten; wer weiß, ob es noch für was gut sein kann.

1. <?php
2. /*
3. Deklariert Methoden und Konstanten für einen
4. Bildeintrag in die sitemap.xml
6. Author: Hermann J. Leopold
7. Email: hermann.leopold@leopoldnet.de
8. Date: 2017-02-02
10. /*
11. interface ILeo_Sitemap_Image
12. {
13. // Symbol des Image-Elements
14. const csImageSymbol = "image:image";
16. // Symbol des Location-Elements
17. const csLocSymbol = "image:loc";
19. // Symbol des Untertitel-Elements
20. const csCaptionSymbol = "image:caption";
22. // Symbol des Aufnahmeort-Elements
23. const csGeoLoaction = "image:geo_location";
25. // Symbol des Titel-Elements
26. const csTitle = "image:title";
28. // Symbol des Lizens-Elements
29. const csLicense = "<image:license>";
31. // Ich wechsle hier von Loc auf Url,
32. // um Verwechslungen zu vermeiden.
33. function setUrl($sUrl);
35. // Angabe des Untertitels
36. function setCaption($sCaption);
38. // Angabe des Aufnahmeorts
39. function setGeoLocation($sGeoLocation);
41. // Angabe des Bildtitels
42. function setTitle($sTitle);
44. // Angabe der Lizens-Elements
45. function setLicense($sLicense);
46. }

Jetzt wird es Zeit für Konkretes.

Ich mag Schnittstellen. Schnittstellen (engl. Interfaces) sind ein Instrument objektorientierter Programmierung und sollen – salopp gesagt – sicherstellen, dass verschiedene Programmteile verlässlich zusammen arbeiten können.

Dies spielt besonders dann eine Rolle, wenn Erweiterungen oder ähnliches später und/oder von anderen erstellt werden sollen.

Schnittstellen wären auch eine Möglichkeit für WordPress gewesen, jedoch wurde darauf verzichtet; wohl auch, da PHP keine reine objektorientierte Programmiersprache ist. Auch werden die meisten bei der Entwicklung eines Plugins darauf verzichten, ich jedoch nicht.

Mir gefällt, dass ich auf diese Weise Ideen und Anforderungen in Code festschreiben kann, ohne bereits ins Detail gehen zu müssen; und es entstehen Arbeitsanweisungen für die konkreten Klassen.

Folgende Schnittstellen sind mir in den Sinn gekommen:

ILeo_Sitemap_Xml

1. <?php
2. /*
3. Deklariert Methoden und Konstanten für eine XML-Datei
5. Author: Hermann J. Leopold
6. Email: hermann.leopold@leopoldnet.de
7. Date: 2017-01-30
9. /*
10. interface ILeo_Sitemap_Xml
11. {
13. // Ich mag die Idee, dass ein ständig gleich benötigtes Zeichen einmal festgelegt wird.
14. const csTagAuf = "<";
16. // Hier kann festgelegt werden, ob es nach einem XML-Tag einen Zeichenumbruch geben soll.
17. // const csTagZu = ">";
18. const csTagZu = ">\n";
20. // Das Wichtigste: Das XML-Dokument als String
21. function toString();
23. }

Datei: ILeo_Sitemap_Xml.php

Natürlich wird so eine XML-Datei nicht annährend vollständig beschrieben, doch für das Plugin reicht es. Da sich Inhalt und Attribute der Elemente unterscheiden, brauche ich dafür keine Methoden vorschreiben. Das Festlegen der spitzen Klammern als Konstanten ist nicht Humor, sondern es bringt Vorteile:

• Einmal festeglegt, kann man sie nur noch vergessen, aber nicht verwechseln. Da es auch nur eine Methode geben wird, in der die Klammern verwendet werden, sind die Tags stets richtig (oder stets falsch).
• Bei der schließenden Klammer kann festgelegt werden, ob es Zeilenumbrüche geben soll. Diese machen zwar das XML-Dokument lesbarer, aber auch größer.

ILeo_Sitemap

1. <?php
2. /*
3. Deklariert Methoden und Konstanten für eine sitemap.xml
5. Author: Hermann J. Leopold
6. Email: hermann.leopold@leopoldnet.de
7. Date: 2017-01-30
9. Verzeiht mein Denglish..
10. /*
11. interface ILeo_Sitemap
12. {
13. // Symbolname des Wurzelelements
14. const csRootSymbol = "urlset";
16. // Der übliche Dateiname, sollte er nicht ersetzt werden.
17. const csDefaultName = "sitemap.xml";
19. // Legt den Namen der Datei fest; bsp.: sitemap.xml
20. function setSitemapName($sName);
22. // Gibt die Url der Website an; bsp.: leopoldnet.de
23. // Wichtig, da die Verweise meist relativ sind, aber absolut sein müssen.
24. function setSiteUrl($sUrl);
26. // Der Pfad zum Speichern wird auch benötigt.
27. function setPath($sPath);
29. // Das Wichtigste: Seiten der sitemap hinzufügen.
30. // Was eine Seite ausmacht, wird in der ILeo_Sitemap_Page festgelegt.
31. function addPage(ILeo_Sitemap_Page $oPage);
33. }

Datei: ILeo_Sitemap.php

Der Name der Datei ist nicht festgelegt; somit wäre es möglich, für verschiedene Suchmaschinen unterschiedliche Sitemaps zu erstellen. Auch der Speicherpfad ist (im Rahmen des Möglichen) wählbar; es muss nicht das Wurzelverzeichnis sein.

Wichtig ist das hinzufügen der Seiten. Die dafür vorgesehene Methode ‚addPage()‘ erwartet einen Parameter vom (noch) unbekannten Typ ILeo_Sitemap_Page. Alles, was eine Seite (aka Page) ausmacht, wird in der nächsten Schnittstelle deklariert.