Store Locator ( locator ) – Finger weg! Warum?

Die Extension Store Locator ( locator ) taucht immer wieder (zumindest im deutschsprachigen Raum) als Empfehlung für Umkreissuchen auf. D.h. wenn es drum geht, Filialen, Händler odgl. in einem gewissen Umkreis zu suchen, ausgehend von einer vom bestimmten User bestimmten Position.

Warum man aber tunlichst die Finger von der Extension lassen sollte, hat mir das vergangene Wochenende gezeigt….

Leichtes Warmwerden

Begonnen hatte das Eintauchen in den Code des Store Locator mit dem Hinweis einer Kundin, dass auf ihrer Website keine Orte mit scharfem S gefunden werden bzw. nur, wenn man dieses als „ss“ eingibt. Der Weg führte mich dann durch den PHP-Code bis zu den Abfragen der Geopositioning-Dienste, die in der Datei pi1/class.tx_locator_model.php zu finden sind. Hier kam dann der Schock:

  1. Coding Guidelines existieren nicht bzw. werden ignoriert
  2. Umgang mit Zeichensätzen ist willkürlich
  3. Konfigurationsvariablen von Extension und TYPO3 werden teils ignoriert bzw. hart überschrieben
  4. Geopositioning-Dienste werden abgefragt, die ihren Dienst (in der API-Version) eingestellt haben
  5. 40 hidden-Fields statt einem DB-Requests
  6. SQL-Queries werden zusammengebaut, die UIDs vermischen und Werte überschreiben
  7. Missachtung der enablecolumns/enableFields
  8. TYPO3-API ist in weiten Teilen anscheinend unbekannt
  9. Vermischung der MVC-Einheiten
  10. Logische Fehler

Weiterlesen»

Dokumentation von Extensions

RTFM – wenn denn wirklich eines da wäre… Viel zu oft trifft man auf TYPO3-Extensions – auch eigene – deren Dokumentation mit etwas Glück mager ausgefallen ist, oft aber schlicht nicht existiert. Dies ist ärgerlich, weil man dadurch im TER nur schwer abschätzen kann, ob eine vorhandene Extension die gesuchte Funktionalität bietet, und weil bei individuellen (Kunden-)Extensions nach gewisser Zeit oft Kollegen (und man selbst) auch nicht mehr so genau weiß, was die Extension tut, wie sie es tut oder warum sie es so tut.
Aber warum dokumentieren wir so wenig? Mit ein paar wenigen Schritten und mit Vorlagen erleichtern wir uns selbst, unseren Kollegen und der Community das Leben. Also auf geht’s!

In „How typo3.org works“ beschreibt Kasper Automatismen rund um die TYPO3-Plattform incl. TER. Uns interessiert hierbei insbesondere der Abschnitt „1.3. Writing documentation for TYPO3“. Dort wird erklärt, wie aus einem einfachen OpenOffice-Manual die Online-Ansichten der Manuals entstehen, und warum die Struktur und Formatierung dabei entscheidend ist.
Ein Documentation template für korrekt formatierte Manuals mit zahlreichen Hinweisen steht im TER bereit.

Es ist wirklich kein Hexenwerk. Packen wir also mal wieder unseren inneren Schweinehund, und dokumentieren unsere Extensions.

Links: