EventList und Plugins

schlu blog

Friday, 20. February 2009

EventList und Plugins

Entwicklung EventList
In der stable kam eine Funktion hinzu die wohl einige eher in der 1.1 erwartet hätten, Plugin support. Nein, nicht die schon lange unterstützen "content" Plugins, sondern EventList eigene, welche auf bestimmte Aktionen beliebig reagieren können.
Um ein paar Beispiele zu geben was damit möglich wird kann man sich zwei bereits existierende Plugin für EventList etwas näher anschauen.
Zum einen das Plugin das Jomsocial und EventList verbindet. Hier werden Aktionen innerhalb EventList, wie zum Beispiel das Einreichen oder Anmelden zu einer Veranstaltung, umgehend in einem "Activity stream" innerhalb Jomsocials angezeigt sowie die Profil Avatare aus Jomsocial geladen und anstatt der üblichen Namensliste der angemeldeten Nutzer dargestellt. Also das Jomsocial äquivalent zur fest integrierten Community Builder Unterstützung.

Das zweite Plugin ist das "mailer" Plugin (Nur in SVN zur Zeit des Eintrags) welches Benachrichtigungsfunktionen für die Registrier- und Abmeldeaktionen nachrüstet. Ist dieses installiert können sowohl dem Nutzer der sich zB. anmeldet bzw. dem Administrator eine Bestätigungs- respektive Informations Email zugeschickt werden.

Wie man anhand der obigen Beispiele schon merken kann sind den Plugins im Moment noch Grenzen gesetzt. Ihnen wird lediglich mitgeteilt es passiert etwas, es schaut ob es davon betroffen ist, also tut es was und dazu bekommt es meistens ein geradezu lächerliches Maß an Daten. Die Event ID und evtl. noch die Info ob es sich um einen neuen Event handelt. Plugins, wie von Joomla bekannt, welche vor der eigentlichen Anzeige noch zB die Eventdaten bearbeiten könnten sind noch nicht möglich. Das dürfte erst in der 1.1 unterstützt sein.

Das war der Versuch einmal so wenig technisch wie es mir möglich ist die grundsätzliche Funktionsweise sowie die Möglichkeiten für Anwender die sich daraus ergeben zu beschreiben. Denke das hat einigermaßen geklappt :-)

Doch nun geht es mehr ins Detail allerdings im Schnelldurchgang. Wir "basteln" ein Plugin für EventList. Dazu sollten wir natürlich erst einmal wissen welche Aktionen zur Verfügung stehen:

  • onEventEdited

  • onVenueEdited

  • onEventUserRegistered

  • onEventUserUnregistered

  • onAttendeeDisplay

Die Aktionen die damit beschrieben werden sollten selbst erklärend sein. Wichtig ist es zu wissen, dass sich EventList Plugins an den üblichen Joomla Plugins orientieren und lediglich einer eigenen "Plugin Gruppe/typ" zugeordnet sind. Wer also schon für Jooomla Plugins geschrieben hat sollte mit Plugins für EventList keine Probleme haben. Diese Lektüre gilt also nach wie vor.

Nun kommen wir zum ersten Schritt der Geschichte: Der XML Datei
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <install version="1.5.2" type="plugin" group="eventlist" method="upgrade">
  3.   <name>EventList - Example Plugin</name>
  4.         <author>Author</author>
  5.         <creationDate>Month 2009</creationDate>
  6.         <copyright>Copyright (C) 2009 Holder. All rights reserved.</copyright>
  7.         <license>GNU General Public License 2</license>
  8.         <authorEmail>email</authorEmail>
  9.         <authorUrl>url</authorUrl>
  10.         <version>1.0</version>
  11.         <description>A Plugin forEventList which does nothing</description>
  12.         <files>
  13.                 <filename plugin="example">example.php</filename>
  14.         </files>
  15.         <params>
  16.               <param name="example" type="text" default="" label="Example" description="An example text parameter" />
  17.         </params>
  18. </install>

Zwei wichtige Punkte sind hier zu beachten:
  • Das "group="eventlist" im install tag macht dieses Plugin de facto zu einem EventList plugin. Steht da etwas anderes interessiert sich Eventlist nicht dafür und es wird nicht ausgeführt.

  • Etwas nicht EventList spezielles aber erwähnenswert: example.php Hier gebt Ihr zum einen die Plugin Datei an (hier example.php) sowie den "Plugin Namen" der euch im folgenden noch begleiten wird. Er sollte also zumindest etwas überlegt sein.

Das eigentliche Plugin:

  1. <?php
  2. //Kein direkter Zugriff
  3. {FNAMEL}">defined( '_JEXEC' ) or {FNAMEL}">die( 'Restricted access' );
  4.  
  5. //Abhängigkeiten importieren
  6. jimport('joomla.event.plugin');
  7.  
  8. class plgEventlistExample extends JPlugin {
  9.  
  10.         /**
  11.          * Constructor (php4)
  12.          *
  13.          * @param object $subject The object to observe
  14.          * @param       array  $config  An array that holds the plugin configuration
  15.          * @since 1.0
  16.          */
  17.         function plgEventlistExample(&$subject, $config = {FNAMEL}">array())
  18.         {
  19.                 parent::__construct($subject, $config);
  20.         }
  21.        
  22.         /**
  23.          * Methode für onEventUserRegistered
  24.          *
  25.          * @access      public
  26.          * @param   int         $event_id
  27.          * @return      boolean
  28.          * @since 1.0
  29.          */
  30.         function onEventUserRegistered($event_id)
  31.         {
  32.                 //tu was wenn sich jemand zu einer Veranstaltung anmeldet
  33.                
  34.                 return true;
  35.         }
  36.        
  37.         /**
  38.          * Methode für onEventUserUnregistered
  39.          *
  40.          * @access      public
  41.          * @param   int         $event_id
  42.          * @return      boolean
  43.          * @since 1.0
  44.          */
  45.         function onEventUserRegistered($event_id)
  46.         {
  47.                 //tu was wenn sich jemand von einer Veranstaltung abmeldet
  48.                
  49.                 return true;
  50.         }
  51.        
  52.         /**
  53.          * Methode für onEventEdited
  54.          *
  55.          * @access      public
  56.          * @param   int         $event_id
  57.          * @param   int         $isNew
  58.          * @return      boolean
  59.          * @since 1.0
  60.          */
  61.         function onEventEdited($event_id, $isNew)
  62.         {
  63.                 if ($isNew) {
  64.                         //tu was wenn eine Veranstaltung neu angelegt wird
  65.                 } else {
  66.                         //tu was wenn eine Veranstaltung bearbeitet wurde
  67.                 }
  68.                 return true;
  69.         }
  70.        
  71.         /**
  72.          * Methode für onVenueEdited
  73.          *
  74.          * @access      public
  75.          * @param   int         $venue_id
  76.          * @param   int         $isNew
  77.          * @return      boolean
  78.          * @since 1.0
  79.          */
  80.         function onVenueEdited($venue_id, $isNew)
  81.         {
  82.                 if ($isNew) {
  83.                         //tu was wenn ein Veranstaltungsort neu angelegt wird
  84.                 } else {
  85.                         //tu was wenn ein Veranstaltungort bearbeitet wurde
  86.                 }
  87.                 return true;
  88.         }
  89.        
  90.         /**
  91.          * Methode für onAttendeeDisplay
  92.          *
  93.          * @access      public
  94.          * @param   int         $user_id
  95.          * @param   string      $text
  96.          * @return      boolean
  97.          * @since 1.0
  98.          */
  99.         function onAttendeeDisplay($user_id, &$text)
  100.         {
  101.                 //hier lassen wir das Plugin doch noch etwas machen, wenn auch komplett unnütz
  102.                 //wir holen uns den parameter example und geben dessen wert
  103.                 //in der liste der registrierten nutzer aus
  104.                 $text = $this->params->get('example', '');
  105.                
  106.                 return true;
  107.         }
  108. }
  109. ?>

Jetzt müssen diese zwei Dateien nur noch gepackt und via dem Joomla Extension installer installiert werden, aktivieren und fertig :-)
Das wars auch schon. Viel mehr gibt es dazu nicht zu sagen.

Nun die Rückfrage...welche Ideen für Plugins habt Ihr die man gegenwärtig umsetzen könnte? Welche hooks/events würdet Ihr euch für die 1.1 wünschen? Schreibt doch kurz dazu etwas in die Kommentare.

PS: Dieser Blogpost erfüllt natürlich in keinster Weise den Anspruch technischer Dokumentation ;-) Das kommt noch, wenn Zeit, auf schlu.net
Posted by
Christoph Lukes
in Entwicklung, EventList at 23:12 | 8 Comments | No Trackbacks
Bookmark and Share
Trackbacks
Trackback specific URI for this entry
No Trackbacks
Comments
Display comments as (Linear | Threaded)
*Meiner Ansicht nach Sinnvoll wären noch an Hooks:

- onVenueDeleted
(sinnvoll für Mailerplugin, weil: z.B. Info an User oder Admin wenn das Event abgesagt wird o.Ä.)

- onAfterEventDisplay
- onPrepareEventDisplay
(Sinnvoll um Beispielsweise irgendwelchen Content ÜBER oder UNTER dem Event Anzeigen zu lassen, z.B. Buttons/Links zur Kartenregistrierung...)

- onCreateVenue
(Sinnvoll um z.B. den Admin darüber zu informieren um auch zu schauen ob es sich nichtum Müll handelt)

Und weisste was richtig cool wäre an Plugins/Möglichkeiten:
- wenn das Votingsystem aus QuickFAQ/QuickLoad in den Events auftauchen würde, somit könnten User "vergangene" Events bewerten.
- wenn man Bilder vergangener Events darstellen könnte, Beispielsweise aus Joomgallery/PhocaGallery usw.

Das wars, sind in meinen Augen alles coole Features die sicher gut ankommen würden. Ich selber hab leider keine Verwendung mehr dafür, aber egal :-P
#1 serk (Homepage) on 2009-02-21 20:43 (Reply)
*I've just translated the module latest_events to spanish. I can't see how to send the file to you, so please email me if you want to include it in the download area.

Nice work.
#2 Francisco Vela (Homepage) on 2009-05-12 12:45 (Reply)
*Hi christoph lukes, i would like to ask you if you can provide me a modified eventlist. I have used it n it worked well n i like it most.

actually i am looking for your email address to ask more if you dont mind...


greeting from Java Indonesia
#3 Iwan (Homepage) on 2009-05-13 14:07 (Reply)
*Da viele Modellflug-Events abseits Google-Maps bekannter Straßen liegen, möchte ich die Ortsmarke selbst setzen können oder den Ort mittels Koordinaten eingeben.
#4 harald (Homepage) on 2009-05-30 21:00 (Reply)
*Hi Lukes,

dieses Feature zu ermöglichen wäre auch super.

http://www.schlu.net/forum/index.php?f=19&t=7645&p=16754&hilit=verbindlich&rb_view=viewtopic#p16754

Danke, Carlo
#5 padrecarlo on 2009-07-18 00:06 (Reply)
*Servus,

eine Event-Importfunktion wäre super, entweder automatsich, z.B. Events in München, oder ne Poollösung, mit Filterfunktion und Einbindung in die EventList.
#6 Henen on 2009-08-06 23:30 (Reply)
*Hallo,

du erwähntest in deinem Dezember-Eintrag, daß ihr an einer CSV Import-Funktion arbeitet. Da ich so etwas dringend suche würde ich mich als Tester anbieten.

Gruß
Toni
#7 Toni (Homepage) on 2009-08-23 17:21 (Reply)
*ist schon in der svn, einfach trunk installieren
#7.1 Christoph Lukes on 2009-08-24 11:21 (Reply)
Add Comment
Enclosing asterisks marks text as bold (*word*), underscore are made via _word_.
Standard emoticons like :-) and ;-) are converted to images.
 
   
 

Kategorien



All categories

About

Werbung

Archives

Blog abonnieren

Twitter

    Links

    Quicksearch