Building a Joomla Module
1 like1,846 views
The document is a tutorial by Cory Webb on building a Joomla module to display an article, presented at Joomla Day Chicago 2017. It covers the creation of module files, displaying a 'hello world' message, performing a database query to fetch an article, and organizing the output with a helper file and template layout. It also includes instructions for installation and further customization of the module.
Building a Joomla Module
- 1. Building a Joomla Module Cory Webb Joomla Day Chicago 2017 CoryWebbMedia.com CWExtensions.com @corywebb
- 2. Who is this guy? • Joomla developer since 2003 (Mambo) • Owner Cory Webb Media & CWExtensions.com • Course creator for OSTraining.com • Author of Beginning Joomla Web Site Development (Wrox, 2009)
- 3. Agenda • Build a module to display a Joomla article • Hello World • Database query • Display the article • Add a helper file • Add a template layout
- 5. Build the Module • Create folder named mod_article_display • Add 2 files: mod_article_display.php mod_article_display.xml • Add language files: en-GB.mod_article_display.ini en-GB.mod_article_display.sys.ini • Discover install
- 6. Hello World • Display “Hello World” in the module output • Edit mod_article_display.php defined(‘_JEXEC’) or die; echo ‘<h3>Hello world!</h3>’; • Publish the module
- 7. Database Query • Get the article ID $article_id = $params->get(‘article_id’); • Create the query $db = JFactory::getDbo(); $query = $db->getQuery(true); $query->select(‘*’)->from(‘#__content’)->where(‘id = ‘ . $article_id); $db->setQuery($query); • Load the article $article = $db->loadObject();
- 8. Display the article • Get a link to the article with ContentHelperRoute JLoader::register(‘ContentHelperRoute', JPATH_SITE . '/components/com_content/ helpers/route.php'); $article->slug = $article->id . ‘:’ . $article->alias; $article->link = JRoute::_( ContentHelperRoute::getArticleRoute( $article->slug, $article->catid, $article->language ) ); • Display the article echo ‘<h3><a href=“’ . $article->link . ‘“>’ . $article->title . ‘</a></h3>’; echo ‘<div class=“article-display-article”>’ . $article->introtext . ‘</div>’; echo ‘<p><a href=“‘ . $article->link . ‘“ class=“read-more”>Read More</a></p>’;
- 9. Add a Helper File • helper.php class ModArticleDisplayHelper {…} • Load the helper class JLoader::register('ModArticleDisplayHelper', __DIR__ . ‘/helper.php'); • Move logic to helper $article = ModArticleDisplayHelper::getArticle($params);
- 10. Add a Template Layout • tmpl/default.php • Load the template require JModuleHelper::getLayoutPath('mod_article_display', $params->get('layout', ‘default'));