Joomla! Blank Content Plugin

on Sonntag, 18 September 2011. Posted in Joomla

Joomla! Blank Content Plugin

Das Joomla! Blank Content Plugin ist ein leeres Plugin für Joomla-Entwickler. Es besteht aus allen grundlegenden Klassen und Funktionen, die ganz einfach erweitert und für die eigenen Anwendungen ausgebaut werden können.

Die Funktionsweise dieses Content Plugins besteht darin, dass ein einfacher String, der in den Content einer Joomla! Seite eingebaut wird, mit einem individuellen Code ersetzt und angezeigt wird.

 

Allgemeine Funktion

Ein sogenanntes Content Plugin bindet sich in den Content (zu deutsch Inhalt) einer Homepageseite ein.

Zum Beispiel habe ich ein Content Plugin entwickelt, dass einen Zufallswitz aus der Datenbank von Funny4You ausliest und in die Joomla! Seite integriert.
In den Content wird hier nur ein kleines Codeschnipsel eingebaut und schon wird genau an dieser Stelle der Text des Witzes angezeigt.

Dieses Codeschnipsel könnte etwa so ausschauen:

{zufallswitz}

Dieses angesprochene Plugin mit genauer Erklärung findest du hier: Witze für Joomla!

 

Da ich in den letzten Wochen verschiedene Content Plugins entwickelt habe, habe ich mir das Blank Content Plugin erschaffen, das ich für alle Entwicklungen als Ausgangsbasis verwende. Es beinhaltet alle notwendigen Joomla! Klassen und Funtionen, und die Möglichkeit mehrere Parameter an das Plugin zu übergeben.

Die Parameter

Wie ich schon weiter oben geschrieben habe, wird ein kleines Codeschnipsel in den Content geschrieben, das vom Plugin erkannt wird und stattdessen mit einem anderen Inhalt gefüllt wird.
Dieses Codeschnipsel kann auch mehrere Parameter an das Plugin übergeben.

Ich habe z.B. auch ein Plugin geschrieben, dass eine externe Datei ladet. Als Parameter kann man hier den Dateinamen wählen. Somit hat man ein Plugin, dass die unterschiedlichsten Dateien laden kann. Je nach dem welcher Dateiname als Parameter übertragen wird.

So eine Parameterübergabe könnte folgendermaßen ausschauen:

{NameDesPlugins param="dateiname.php"}

 

Das Blank Content Plugin

Das Pugin gibt nur einen einfachen Ausgabecode aus. Zuerst eine <h3> Überschrift mit dem Inhalt "Blank Content Plugin" und dann je nach Parameter eine <h4> Überschrift gefolgt von 2 <p> Absätzen.

Es besteht aus 3 Dateien.

  • blankContentPlugin.xml
  • blankContentPlugin.php
  • index.html

blankContentPlugin.xml

Diese Datei enthält alle für die Installation notwendigen Daten. Was du dort wie ändern musst ist selbsterklärend und daher möchte ich hier nicht näher darauf eingehen.

blankContentPlugin.php

Das ist die eigentliche Plugindatei. Hier musst du deinen Code für deine individuelle Entwicklung schreiben.
In der Datei selbst habe ich viele Kommentare geschrieben, um zu sehen welcher Code was macht.

index.html

Das ist nur zur Sicherheit, damit der Ordnerinhalt beim ansurfen des Ordners nicht angezeigt wird.

 

Anwendung bzw. Einbau

Der Einbaucode für dieses Blank Content Plugins lautet ohne Parameter lautet:

{ BlankContentPlugin}
Das Leerzeichen nach dem { darf nicht geschrieben werden. Ich kann es leider hier nicht anders schreiben.

Demo

Blank Content Plugin

Mit Parameter kann es so aussehen:

{ BlankContentPlugin param1=Hello!|param2=it works fine|param3=Joomla! rocks ;-)}
Das Leerzeichen nach dem { darf nicht geschrieben werden. Ich kann es leider hier nicht anders schreiben.
Nach jedem Parameterwert (außer beim Letzten) muss das Zeichen: | geschrieben werden!

Demo

Blank Content Plugin

Hello!

it works fine

Joomla! rocks ;-)

 

Ein Content Plugin kann auch in einen Modul "Eigene Inhalte (Leeres Modul)" eingebaut werden. Hier muss in den Basisoptionen die Einstellung "Inhalte vorbereiten" ja gewählt werden.

 

Download und Installation

Hier kannst du das Plugin Downloaden: BlankContentPlugin

Das Plugin wird wie jedes andere Plugin bzw. Modul, Template oder Komponente über den Joomla Installer installiert.

Nicht vergessen: Das Plugin muss nach der Installation noch aktiviert werden!

 

Viel Spaß beim Entwickeln deiner eigenen Joomla! Plugins.

Social Bookmarks

Kommentare (5)

  • Wolfgang

    Wolfgang

    05 November 2011 at 20:14 |
    Hallo
    Grundsätzlich ist das "Blank Content Plugin" für Pluginanfänger suuuuper.
    Nur es sollte bitte aber auch so funktionieren wie beschrieben.

    Denn in der Foreach Schleife werden alle Übergabeparameter bis auf das letzte wider gelöscht.

    Danke
    Wolfgang
    • Günther Hörandl

      Günther Hörandl

      06 November 2011 at 02:10 |
      Hallo Wolfgang!

      Danke für die Meldung. Ich habe den Code gerade kontrolliert. Du hast recht.
      Irgendwie ist mit bei der Download-Version ein Fehler unterlaufen. Ich habe ihn sofort korrigiert und die funktionierende Version online geschaltet.

      Danke und viele Grüße,
      Günther
  • Christian

    Christian

    08 Januar 2012 at 21:47 |
    Hey, ich habe gerade das Plugin geladen, weil ich eine .php in den Content laden möchte, nur wird mir bei dem code {balnkContentPlugin param="dateiname.php"} nur der Name "Blank Content Plugin" angezeigt....oder hab ich da jetzt was falsch gemacht.

    LG
    • Günther Hörandl

      Günther Hörandl

      08 Januar 2012 at 21:58 |
      wenn du das Plugin unverändert verwendest, dann ist die Ausgabe richtig.
      Das "blankContentPlugin" ist für weitere Entwicklungen gedacht.
      Das es eine externe Datei ladet ist nicht im Programmcode enthalten.
  • Jens

    Jens

    24 Mai 2012 at 23:41 |
    super :) echt klasse zum einstieg! danach habe ich gesucht! weiter so!

Bitte Kommentar schreiben

Bitte einloggen, um einen Kommentar zu schreiben.