Joomla! 1.5 Extensions

Transkript

1 4. Web Development Fulda Treffen Joomla! 1.5 Extensions Erstellung von Plugins, Modulen und Komponenten Achim Fischer

2 Basics: PHP MySQL

3 Extension Typen: Plugins Module Komponenten

4 Worin unterscheiden sich die 3 Typen?

5 Was sind die jeweiligen Einsatzgebiete?

6 Plugins Ereignisgesteuert wie z.b. Datenbank Trigger Beispiel: Ein Plugin das beim Anzeigen von Content, Smilie Code mit Smilies ersetzt

7 Module Werden an Modulpositionen des Templates angezeigt. Unterstützen häufig Komponenten Beispiel: Letzte 10 Einträge im Forum

8 Komponenten Werden im Hauptbereich des Templates angezeigt Entsprechen Applikationen Beispiele: Diskussions Forum Kleinanzeigenmarkt

9 Plugins

10 Plugins Observer Pattern Einklinken in Systemevents Ändern von Systemfunktionalität ohne ändern von Systemcode

11 Plugins bestehen aus 1 XML Datei 1 PHP Datei

12 Plugins: discussions.xml <?xml version="1.0" encoding="utf-8"?> <install version="1.5" type="plugin" group="system"> <name>system - Discussions</name> <author>codingfish Limited</author> <creationdate>march 2009</creationDate> <copyright>copyright (C) 2009 Codingfish Limited. All rights reserved.</copyright> <license> GNU/GPL</license> <author >info@codingfish.com</author > <authorurl> <version>1.0</version> <description>plugin for Codingfish Discussions</description> <files> <filename plugin="discussions">discussions.php</filename> </files> <params/> </install>

15 Plugins: Gruppen Es gibt 8 Core Groups: authentication content editors editors-xtd search system user xmlrpc Eigene Gruppen sind möglich

16 Plugins: Gruppen Zu beachten: Nur jeweils 1 Plugin mit demselben Namen pro Gruppe Es gibt reservierte Namen in den einzelnen Gruppen z.b. cache, debug, legacy, log und remember in system

17 Plugins: discussions.php <?php defined('_jexec') or die( 'Restricted access' ); jimport('joomla.plugin.plugin'); class plgsystemdiscussions extends JPlugin { function onafterstoreuser( $user, $isnew, $success, $msg) { global $mainframe; if ( $isnew && $success) { // add a record to # discussions_users $db = JFactory::getDBO(); $sql = 'INSERT INTO '.$db->namequote('# discussions_users'). ' SET '. $db->namequote('user_id').' = '.$user['id']; $db->setquery( $sql); $db->query(); } else { // user is updated // currently not needed } } }

18 Plugins: plg_discussions.zip discussions.xml + discussions.php = plg_discussions.zip

19 Plugins: Installationsort

20 Module

21 Module: Modul Positionen im Template Beispiel:... <?php if ($rightcolumn_width!= 0) :?> <div id="rightcol"> <div class="padding"> <?php if ($subnav and $splitmenu_col=="rightcol") :?> <div class="sidenav-block"> <?php echo $subnav;?> </div> <?php endif;?> <jdoc:include type="modules" name="right" style="block" /> </div> </div> <?php endif;?>...

22 Module bestehen mindestens aus 1 XML Datei 1 PHP Datei

23 Module: mod_discussions_recent.xml <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE install SYSTEM " <install version="1.5" type="module" client="site"> <name>discussions RecentX</name> <author>codingfish Limited</author> <authorurl> <creationdate>august 2009</creationDate> <copyright>copyright (C) 2009 Codingfish Limited. All rights reserved.</copyright> <license> GNU/GPL</license> <version>1.0</version> <description>module for Codingfish Discussions. Displays recent X forum postings</ description> <files> <filename module="mod_discussions_recentx">mod_discussions_recentx.php</ filename> </files> </install>

24 Module: mod_discussions_recent.php <?php defined('_jexec') or die('restricted access'); $number = $params->get( 'number', 10 ); $db = & JFactory::getDBO(); $posts = null; $query = 'SELECT cat_id, thread, subject, DATE_FORMAT( date, "%d.%m.%y %k:%i") AS createdate'. ' FROM # discussions_messages'. ' WHERE published = 1 AND cat_id!= 10 AND cat_id!= 11 AND cat_id!= 12'. ' ORDER BY date DESC LIMIT '. $number; $db->setquery($query); $posts = $db->loadobjectlist(); if ($db->geterrornum()) { JError::raiseWarning( 500, $db->stderr() ); } if (count($posts)) { foreach ($posts as $post) { $link = "/forums/thread/". $post->cat_id. "/". $post->thread. ".html"; echo "<a href='".$link."'>"; echo $post->subject; echo "</a>"; echo "<br />"; echo $post->createdate; echo "<br />"; } }

25 Module: mod_discussions_recentx.zip mod_discussions_recentx.xml + mod_discussions_recentx.php = mod_discussions_recentx.zip

26 Module: Installationsort

27 Module: Website -> Template Position right

28 Komponenten

29 Komponenten: Werden im Hauptbereich des Templates angezeigt Entsprechen Applikationen/Programmen

30 Komponenten: 2 Bereiche Frontend Backend

31 Komponenten bestehen aus 1 XML Datei und Unmengen an PHP, CSS, SQL, Images,...

32 Komponenten: Verzeichnisstruktur (Frontend)

33 Komponenten: discussions.xml (Auszug) <install> <sql> </sql> </install> <uninstall> <sql> <file driver="mysql" charset="utf8">install.mysql.utf8.sql</file> <file driver="mysql">install.mysql.sql</file> <file driver="mysql" charset="utf8">uninstall.mysql.sql</file> <file driver="mysql">uninstall.mysql.sql</file> </sql> </uninstall> <files folder="site"> <folder>assets</folder> <folder>classes</folder> <folder>includes</folder> <folder>models</folder> <folder>views</folder> <filename>index.html</filename> <filename>discussions.php</filename> <filename>controller.php</filename> <filename>router.php</filename> </files> <administration> <menu>discussions</menu> <submenu> <menu link="option=com_discussions">configuration</menu> <menu link="option=com_discussions">categories</menu> <menu link="option=com_discussions">threads</menu> </submenu> <files folder="admin"> <filename>install.mysql.utf8.sql</filename> <filename>install.mysql.sql</filename> <filename>uninstall.mysql.sql</filename> </files> </administration>

34 Komponenten: discussions.xml (Auszug) <install> <sql> </sql> </install> <uninstall> <sql> <file driver="mysql" charset="utf8">install.mysql.utf8.sql</file> <file driver="mysql">install.mysql.sql</file> <file driver="mysql" charset="utf8">uninstall.mysql.sql</file> <file driver="mysql">uninstall.mysql.sql</file> </sql> </uninstall> <files folder="site"> <folder>assets</folder> <folder>classes</folder> <folder>includes</folder> <folder>models</folder> <folder>views</folder> <filename>index.html</filename> <filename>discussions.php</filename> <filename>controller.php</filename> <filename>router.php</filename> </files> <administration> <menu>discussions</menu> <submenu> <menu link="option=com_discussions">configuration</menu> <menu link="option=com_discussions">categories</menu> <menu link="option=com_discussions">threads</menu> </submenu> <files folder="admin"> <filename>install.mysql.utf8.sql</filename> <filename>install.mysql.sql</filename> <filename>uninstall.mysql.sql</filename> </files> </administration>

35 Komponenten: install.mysql.utf8.sql (Auszug) CREATE TABLE IF NOT EXISTS `# discussions_users` ( ùser_id` int(11) NOT NULL, `view` tinyint(1) NOT NULL DEFAULT '0', òrdering` tinyint(1) NOT NULL DEFAULT '0', `posts` int(11) NOT NULL DEFAULT '0', `status` tinyint(1) NOT NULL DEFAULT '0', àvatar` varchar(100) DEFAULT 'user.png', `signature` text, `titel` varchar(100) NOT NULL, PRIMARY KEY (ùser_id`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; INSERT INTO `# discussions_users` ( user_id) SELECT id FROM `# users` ORDER BY id asc;

36 Komponenten: discussions.php <?php // Check to ensure this file is included in Joomla! defined('_jexec') or die('restricted Access'); // get the controller require_once(jpath_component.ds.'controller.php'); // instantiate and execute the controller $controller = new DiscussionsController(); $controller->execute(jrequest::getcmd('task', 'display')); // redirect $controller->redirect();

37 Komponenten: controller.php <?php // Check to ensure this file is included in Joomla! defined('_jexec') or die('restricted Access'); jimport('joomla.application.component.controller'); class DiscussionsController extends JController { } function display() { // Set a default view if none exists if (! JRequest::getCmd( 'view' ) ) { JRequest::setVar('view', 'index' ); } // display index parent::display(); }

38 Komponenten: index.php (Index Model, Auszug) class DiscussionsModelIndex extends JModel { function getcategories() { $db =& $this->getdbo(); // Load the categories if (empty($this->_data)) { $user =& JFactory::getUser(); $loguser = new CUser( $user->id); if ( $loguser->ismoderator()) { // show me all categories $query = "SELECT c.id, c.parent_id, c.name, c.description, c.image, c.show_image, c.published, c.counter_posts, c.counter_threads, DATE_FORMAT( c.last_entry_date, '%d.%m.%y %k:%i') AS last_entry_date, c.last_entry_user_id, u.username FROM ".$db->namequote('# discussions_categories')."c LEFT JOIN (".$db->namequote('# users')." u) ON u.id=c.last_entry_user_id WHERE c.published='1' ORDER by c.ordering ASC"; } else { // only show the public forums (privates are hidden) $query = "SELECT c.id, c.parent_id, c.name, c.description, c.image, c.show_image, c.published, c.counter_posts, c.counter_threads, DATE_FORMAT( c.last_entry_date, '%d.%m.%y %k:%i') AS last_entry_date, c.last_entry_user_id, u.username FROM ".$db->namequote('# discussions_categories')."c LEFT JOIN (".$db->namequote('# users')." u) ON u.id=c.last_entry_user_id WHERE c.private='0' AND c.published='1' ORDER by c.ordering ASC"; } } $this->_data = $this->_getlist($query); return $this->_data; } } // class

39 Komponenten: index.php (Index View) <?php // Check to ensure this file is included in Joomla! defined('_jexec') or die( 'Restricted access' ); jimport( 'joomla.application.component.view'); class DiscussionsViewIndex extends JView { } /** * Renders the view */ function display() { } $categories =& $this->get('categories'); $this->assignref('categories', $categories); // display the view parent::display();

40 Komponenten: tmpl/default.php (Index Template, Auszug) <?php foreach ( $this->categories as $category ) : catlink = JRoute::_('index.php?option=com_discussions&view=category&catid='. $category->id ); echo "<a href='$catlink' title='$category->name'>".$category->name."</a>"; echo <br /> ; echo $category->description;... endforeach;

41 Komponenten: Discussions

42 Die Erstellung einer kompletten Joomla! 1.5 MVC Komponente...

43 bei Interesse demnächst in diesem Theater :-)

44 Literatur Mastering Joomla! 1.5 Extension and Framework Development James Kennard Learning Joomla! 1.5 Extension Development Joseph L. LeBlanc

45 Kontakt

46 Vielen Dank Achim Fischer