yaml Formular Framework - Default mit Zeilenumbruch (newline, break)

Details

Ein paar YAML Form Framework Lösungen

In diesem nachfolgenden Text habe ich ein paar Problemlösungen zusammengetragen, die mir bei der Arbeit mit YAML-Formularen und der damit erzeugten Feldinhalte untergekommen sind.

 

Problembeschreibung:

Z.B. in einigen PHP-basierten CMS wie Joomla, Wordpress, Gravity, Drupal, Magnolia wo z.B. durch das Templateframework Gantry 5 u.a. YAML als Formular Framework verwendet wird, ist das Erstellen von Formularen dank dieser Konfigurationssprache recht einfach. Allerdings kann man manchmal auf Probleme stoßen, bei denen eine Lösungsfindung nicht recht einfach ist. Grund dafür ist, dass die Dokumentation der Markup-Language YAML mit ca 80 Seiten ein Schwergewicht ist und sperrig zu lesen. Ein weiterer Grund ist, dass die Google-Suche nicht immer brauchbar zu Lösungen führt.

Hier sollen deshalb ein paar kleine Tipps folgen, die das eine oder andere Problem lösen.

Lösung für das Problem Zeilenumbrüche

Wenn man in YAML z.B. eine Feldtyp textarea.textarea erstellt und diesem Textfeld eine Default-Wert übergeben möchte der mehrzeilig ist, z.B. weil man zeigen will, dass pro Zeile ein Keyword einzutragen ist, dann kann man nicht einfach in den Default-Text mit Enter arbeiten. Enter erzeugt eine neue Zeile und damit beginn in YAML ein neuer Knoten. Das führt zwangsläufig zu einem Fehler. Lösungen gibt es dazu gleich einige in YMAL. Die einfachste ist den Zeilenumbruch mit \n zu codieren. Das alleine wird aber ignoriert. Damit der YMAL-Interpreter das korrekt auswertet, muss der gesamte String in doppelte Gänsefüsschen gesetzt werden! Keine Hochkommas verwenden!

Weiterlesen: yaml Formular Framework - Default mit Zeilenumbruch (newline, break)

Joomla Manifest-XML-Scripte für Module, Komponenten und Plugins - Know-How-Sammlung

Details

Dies ist eine kleine Sammlung von Know-How, Links und Tricks rund um das Thema der Joomla-Manifest-XML-Scripte zur Installation und Konfiguration von Module, Komponenten, Templates und Plugins oder auch Libraries. Es tangiert ebenfalls die Form-Fields die innerhalb von Joomla für die Konfigurationsformulare zur Verfügung stehen. Leider sind manche Dinge nicht so allumfassend dokumentiert oder es bestimmte Situationen in der Entwicklung eigener Erweiterungen für die man Work-Arounds benötigt.

 

Wichtige Links mit Dokumentationen

Hier zunächst eine Linklistenzusammenstellung für wichtige Dokumentationen/Manuals zu dem o.g. Themenbereich:

 

Weiterlesen: Joomla Manifest-XML-Scripte für Module, Komponenten und Plugins - Know-How-Sammlung

BreezingForms Meldungen in den sichtbaren Bereich bringen

Details

Problembeschreibung

Die Formularkomponente BreezingForms für Joomla meldet an den Seitenbenutzer diverse Informationen, so z.B. wenn Pflichtfelder nicht ausgefüllt wurden, oder das Formular erfolgreich gesendet wurde. Da Webseiten heutzutage wg. der mobilen Geräte häufig sehr lang sind, oder Formulare sehr viele Felder haben können, kann es passieren, dass diese Meldungen, die bei BreezingForms oberhalb des Formulars eingeblendet werden, oder auf einer Feedbackseite ausgegeben werden, nicht im sichtbaren Bereich liegen. Der Seitenbesucher sieht diese Meldungen nicht, und ist verwundert, oder gar genervt darüber, nicht zu erfahren, was jetzt nach dem Klick auf dem Absendebutton genau passiert ist.

Beide oben genannten Grundprobleme - also die Feedbackmeldung nach dem erfolgreichen Senden und die Fehlermeldungen bei Fehleingaben oder nicht gefüllten Feldern, sind jedoch vom Verhalten etwas unterschiedlich.

Weiterlesen: BreezingForms Meldungen in den sichtbaren Bereich bringen

Wenn der ZIP-Upload im Joomla-MediaManager scheitert

Details

Problembeschreibung ZIP-Upload per MediaManager

Für einen Importfilter innerhalb eine Joomla-Projektes wollte ich dem Kunden über den MediaManager die Möglichkeit zur Verfügung stellen, ZIP-Archive hochzuladen. Dabei zeigte sich ein fast unlösbares Problem. Während z.B. Archive vom Typ GZ oder 7Z unproblematisch hochgeladen werden konnten, gelang das mit unter Windows erstellten ZIP-Archiven einfach nicht. Kontinuierlich erhielt ich beim Uploadversuch die Fehlermeldung:

Fehler

Es wurde versucht eine Datei bzw. mehrere unsichere Dateien hochzuladen.

 

Ursachensuche und gescheiterte Workarounds

Die Ursachensuche gestaltete sich aufwändig. Natürlich hatte ich zunächst vermutet, dass es an den Optionen des MediaManagers liegt. Deshalb hatte ich in die Erlaubten Dateiendungen zip,ZIP, etc. hinzugefügt. Auch in die zu ignorierenden Dateiendungen ZIP,zip einzutragen war keine Lösung. In das Feld Erlaubte Dateitypen (MIME): habe ich dann noch probiert die Liste zu erweitern durch folgende Einträge: application/x-zip,application/x-gzip,application/zip,application/x-7z-compressed,application/x-zip-compressed,application/octed-stream.
Das sind zwar alles Maßnahmen, die nicht unwichtig sind, damit es überhaupt funktionieren kann, aber der Fehler blieb.

 

Weiterlesen: Wenn der ZIP-Upload im Joomla-MediaManager scheitert

Virtuemart Anpassung Rechnungsinhalte und Layout

Details

Know-How-Sammlung für die Anpassung des Layoutes und der inhaltlichen Ausgaben von Rechnungen nach eigenen Bedürfnissen in Virtuemart 3.x.

Die Templates

Sämtliche Templates/Vorlagen für die Erstellung der Rechnungen liegen im Ordner components/com_virtuemart/views/invoice/tmpl/. Von hieraus können Scripte hergenommen und als Overrides in das eigene Template-Verzeichnis abgelegt werden, um nicht die Virtuemart-Core-Scripte modifizieren zu müssen, denn hier bestünde bekanntlich immer die Gefahr, dass dort vorgenommene Anpassungen bei nächsten Updates überschrieben werden würden.

Im o.g. Ordner befinden sich 3 Datei-Hauptgruppen von Vorlagen, die jeweils einen unterschiedlichen Präfix haben:

  • ohne Präfix sind die Templates die für die PDF-Erzeugungen relevant sind
  • der Präfix mail_html erzeugt die html-Mails
  • der Präfix raw_html erzeugt die RAW-Texte-Inhalte in der Mail, die man in der Regel kaum zu Gesicht bekommt und deshalb bei Anpassungen gern vergessen werden.

Dann gibt es jeweils diverse Sub-Template wie z.B. order, items, vendor etc. Diese Sub-Templates können jeweils durch Unteraufrufen eingebunden werden. Wenn man sich z.B. im PDF-invoice-Template befindet (invoice.php) kann mit $this->loadTemplate('items') das Templatescript invoice_items.php eingebunden werden. Auf gleiche Weise kann man sich seine eigenen Schnippsel erstellen und inkludieren.

Ab und zu muss man bei der Templatebezeichnung aufpassen, denn diese sind zwischen den o.g. Templategruppen nicht immer identisch. Während z.B. die Produktzeilen beim PDF invoice_items.php heißt, wird bei den HTML-Mails der Dateiname mail_html_pricelist.php verwendet. Nicht ganz konsequent.

 

Weiterlesen: Virtuemart Anpassung Rechnungsinhalte und Layout

Joomla-Komponenten erzeugen einen Konflikt zwischen MooTools und jQuery (modal.js / SqueezeBox)

Details

Problembeschreibung

Manche Komponenten in Joomla nutzen MooTools, andere und mittlerweile das Joomla selbst verwenden jQuery. Es kann passieren, dass beide JavaScript-Frameworks geladen werden. Das führt jedoch häufig zu Konflikten, weil beide Frameworks den Kurzbezeichner $ verwenden um angesprochen zu werden. Grundsätzlich ist das in Joomla längst kein Problem mehr, selbst dann wenn man beide Frameworks gleichzeitig nutzen will. Zum einen ist gebräuchlich eine jQuery-Methode namen noConflict() einzubinden und zu nutzen. Zum anderene ist es notwendig diese dazu in der korrekten Reihenfolge zu laden. Dies verhindert Konflikte im gleichen Namensraum.

Aber darum muss sich nicht jede Komponente oder der Webmaster der Seite mehr selbst kümmern. Dafür hat Joomla schon diverse Methoden zur Verfügung gestellt, die das korrekte Handling sicherstellen. Wichtig ist nur, dass die Komponte, die z.B. jQuery verwenden will, zur Sicherheit diese Joomla-Methoden verwendet - zum einen das Einbinden der Frameworks über die Klasse JHtml::_(...) und zum anderen die evtl. notw. Reihenfolge und Konfliktvermeidung JHtml::_('behavior.framework', true);.

Weiterlesen: Joomla-Komponenten erzeugen einen Konflikt zwischen MooTools und jQuery (modal.js / SqueezeBox)

Für das Joomla Fancy TagCloud-Module eigene Themes erstellen

Details

Problembeschreibung

Es gibt zwar für das Joomla-Module Fancy TagCloud viele Konfigurationsmöglichkeiten, aber leider ist darüber nicht alles vollständig konfigurierbar. Im Zuge der Umstellung von Projekten auf DSGVO-Konformität bestand ein Bemühen darin, den Zugriff des Projektes auf externe Ressourcen wir z.B. Fonts vom Google-Font-Server zu verhindern. Fancy TagCloud hat diese Einbindung von Fonts fest in Scripte verankert. Es ist nicht konfigurierbar lokale Fonts zu verwenden. Da die Style-Anweisungen auch aus PHP-Scripten kommen, ist es schwer zu verhindern, dass die Fonts von Fremdservern geladen werden. Die einzig Chance bestand darin das Theme-Script anzupassen in dem diese Fonts von e10f949fcaacdb195442bfb5062d59de-gdprlock geladen werden.

 

Lösung

Immerhin bietet Fancy TagCloud die Möglichkeit an im Modul wahlweise alternative Themes zu laden. Zwar wird nur ein einziges im Installationspaket mitgeliefert, aber es ist doch recht einfach daraus weitere Themes zu abzuleiten. In diesem eigenen Theme kann man dann seine gewünschten Modifikationen vornehmen ohne Angst haben zu müssen, dass durch ein Update des Modules diese Modifikationen überschrieben werden würden.

Dazu sind zwei Schritte notwendig:

 

Weiterlesen: Für das Joomla Fancy TagCloud-Module eigene Themes erstellen

Das Formular "Fragen zum Produkt" in Virtuemart um Felder erweitern

Details

Problembeschreibung

Virtuemart bietet in der Produkt-Detail-Seite einen Button mit einem Link zu einem Formular, über welches der Seitennutzer eine Frage zum Produkt stellen kann. Vielen Shopbetreibern ist dieses Formular mit seinen angebotenen Feldern zu dürftig. Es fehlen ggf. wichtige Felder um mit dem Kunden in Kontakt treten zu können. Nur die E-Mail-Adresse ist einfach zu wenig. Deshalb trat ein Kunde mit der Bitte an mich heran, diese Formular um die Felder Straße-und-Hausnummer, PLZ-Ort, Telefon und Betreff zu erweitern. Zunächst hatte ich befürchtet, dass man dazu Core-Scripte modifizieren müsste. Jedoch stellte sich heraus, dass die Lösung zum einen recht einfach ist, und zum anderen keine Core-Scripte betreffen muss. Alles gelingt durch Erzeugen von Template-Override-Scripten im einen Joomla-Template. Diese Beitrag beschreibt den Weg zur Lösung.

 

Lösung in drei Schritten

Natürlich wäre es vom sauberen Stil her notwendig, speziell das Abholen der gesendeten Formularinhalte über das Control-Script components/com_virtuemart/views/askquestion/view.html.php zu realisieren. Dort gehört die Request-Abfrage der Feldinhalte und das Bereitstellen der Inhalte für die Mail-Sende-Aktion eigentlich hin. Nur, das ist eben ein Core-Script und nicht über das Overriding eingebunden. Deshalb sollte man eine Modifikation dort vermeiden. Betroffen sind sind schließlich drei PHP-Template-Scripte und und eine paar CSS-Styles, die man in die custom.css einfügen kann.

Weiterlesen: Das Formular "Fragen zum Produkt" in Virtuemart um Felder erweitern

Maßnahmen zur Beschleunigung von Joomla-Projekten

Details

Eines der Kriterien für eine gutes Suchmaschinenranking und eine positive Nutzererfahrung ist die Geschwindigkeit mit der Seiten geladen werden. Neben dem rein subjektiven Eindruck gibt es auch Webservices, mit denen man objektive Tests durchführen kann. Eine Seite ist z.B. der PageSpeed-Test der Google-Deverloper-Seiten. Hier werden neben einer Bewertung auch Maßnahmen zur Beschleunigung vorgeschlagen.

Für einen Seitenbetreiber eines Joomla-Projektes stellt sich nun also die Frage, wie man die eigene Seite schneller machen kann. Dazu möchte ich nachfolgend ein paar Maßnahmen ausführen.

Weiterlesen: Maßnahmen zur Beschleunigung von Joomla-Projekten

PHP get_class_methods liefert kein Ergebnis obwohl Methoden in der Klasse vorhanden sind

Details

Problembeschreibung: get_class_methods liefert NULL

Ich hatte letztens in einem PHP-Projekt eine neue Klasse programmiert. Über den PHP-Befehl get_class_methods (s. PHP-Manual) sollte ein anderes Script die Methoden dieser php-class auslesen und in einem Pulldown-Selectfeld zur Auswahl zur Verfügung stellen. Das Ergebnis, was die get_class_methods() lieferte war jedoch immer NULL, es wurden keine Methoden erkannt und als Resultat der Abfrage geliefert. Bei anderen class-Scripten funktionierte dieser PHP-Befehl jedoch zuverlässig.

 

Die Lösung war sehr versteckt

Nachdem ich diverse Dinge probiert hatte und schon ziemlich verzweifelt war, und den Fehler in allen möglichen und unmöglichen Ursachen vermutete, was die Lösung schließlich sehr einfach aber versteckt: Ich programmiere mit der IDE PhpStorm unter Windows. Beim Neuanlegen von Scripten wurde als der Zeilenumbruch-Standard für Windows CRLF verwendet.

Weiterlesen: PHP get_class_methods liefert kein Ergebnis obwohl Methoden in der Klasse vorhanden sind

Verhindern dass ENTER ein Formular absendet - statt dessen Verhalten wie Tabulator-Taste

Details

Aufgabenstellung / Zielsetzung

Üblicherweise reagieren alle Formulare auf Websites lt. Browser-Standard gleich, in dem diese beim Drücken der ENTER-Taste auf der Tastatur abgesendet werden. Beginnend mit dem Formular RM-Zuschnitte anfragen/blanko bestellen, sollte dieses Standardverhalten geändert werden, weil der Chef meint, dass das kein Benutzer im Internet so erwarten würde. Vermutlich rührt diese falsche Benutzererwartung daher, dass EXCEL-Benutzer mit Enter zur nächsten Zelle springen können. Deshalb wurde das Verhalten des o.g. Formular speziell für ENTER wie folgt verbogen :

  1. Zunächst sollte das Formular nicht mehr abgesendet werden bei ENTER
  2. Statt dessen sollte ENTER wie Tab funktionieren und bei jedem ENTER zum jeweils nächsten Feld springen.
  3. Welches Feld das nächste ist, weiss ein Formular bei Nutzung der TABULATOR-Taste, aber nicht bei ENTER. Deshalb muss dem Fomular speziell über das Feld-Attribut tabindex eine Reihenfolge mitgegeben werden.
  4. Nur die Felder (z.B. nur Inputfelder aber keine Radio-Buttons) sollen in der Tab-Reihenfolge angesprungen werden. Hier soll also eine Auswahlfreiheit bestehen.
  5. Für die erste ENTER-Eingabe soll bevorzugt ein Feld konfiguriert werden können, welches dann den Fokus erhält. Wenn kein solches Feld definiert wurde, soll das erste Feld in der TabIndex-Liste den Focus erhalten.
  6. Der Submit-Button soll erst wenn er selbst schon den Focus auf sich hat mit ENTER das Formular absenden.

 

Umsetzung im Detail

Für die Gesamte Aufgabenstellung wurde zur Umsetzung eine jQuery-Funktion erstellt, die mit dem betreffenden Fomular geladen wird.

Weiterlesen: Verhindern dass ENTER ein Formular absendet - statt dessen Verhalten wie Tabulator-Taste

Vorgehensweise beim Umbenennen von Bildern in Virtuemart

Details

Aufgabenstellung / Zielsetzung / Problembeschreibung

Wie benenne ich Bilddatein im VirtueMart um, damit diese SEO-friendly und "sauber" also mit Keywords, ohne Umlaute und Unterschtriche, Sonderzeichen oder Ähnliches sind.

Am sinnvollsten ist es, beim erstmaligen Hochladen von Bilddatein bereits auf solche Dinge zu achten.

Folgende Probleme treten womöglich auf: Wenn man ein Bild per FTP auf dem Server umbennen oder löschen ist dieses noch nicht in VirtueMart umbenannt bzw. gelöscht. Problematisch: andersrum allerdings auch nicht! (Auch wenn eine Datei in VirtueMart umbennt oder löscht, ist diese trotzdem noch auf dem Server)

Weiterlesen: Vorgehensweise beim Umbenennen von Bildern in Virtuemart

Welche Bedeutung hat der Unterstrich bei SASS-Scripten

Details

Sie haben es sicher schon gesehen, dass es bei SASS (scss) manche Style-Scripte mit einem Unterstrich im Dateinamen beginnen, andere wiederum nicht. Bei der Import-Einbindung dieser Scripte aber scheint die Schreibweise egal. Was hat das damit aussich?

 

Der Sinn der Underscore-Syntax

...ist, daß hierüber dem SASS-Compiler mitgeteilt werden kann, ob man eine importierte Scriptdatei wirklich mit ihrem Inhalt in eine aufrufende Scriptdatei einbetten will, es also am Ende nur eine einzige Scriptdatei entsteht in der alle so importierten Unterscripte mit ihrem Inhalt enthalten sind. Ohne Unterstrich demgegenüber sagt man jedoch dem Compiler, dass diese so importierte scss-Datei als eine eigenständige css-Datei compiliert erhalten bleibt und klassisch per @import in der fertigen css-Hauptscript aufgerufen wird. D.h., in diesem Fall entstehen ggf. nicht eine einzige CSS-Datei, sondern sehr viele einzelne.

Weiterlesen: Welche Bedeutung hat der Unterstrich bei SASS-Scripten

Seite 2 von 14