Joomla - Criar Módulos

Neste capítulo, estudaremos sobre Creating Modulesno Joomla. Módulos são as extensões flexíveis, leves e úteis para renderização de páginas.

Criar Módulos

A seguir estão as etapas simples para criar módulos no Joomla.

Step 1 - Crie uma pasta chamada mod_firstmodule na tua Joomla → modules pasta.

Step 2 - no mod_firstmodulepasta cria um arquivo chamado "helper.php". Este arquivo contém o nome da classe como auxiliar, ele ajuda a exibir os dados recuperados na saída do módulo.

helper.php

<?php
   /**
      * Helper class for Hello World! module
      *
      * @package    Joomla.Tutorials
      * @subpackage Modules
      * @link http://docs.joomla.org/J3.x:Creating_a_simple_module/Developing_a_Basic_Module
      * @license        GNU/GPL, see LICENSE.php
      * mod_helloworld is free software. This version may have been modified pursuant
      * to the GNU General Public License, and as distributed it includes or
      * is derivative of works licensed under the GNU General Public License or
      * other free or open source software licenses.
   */
		
   class ModHelloWorldHelper {
      /**
         * Retrieves the hello message
         *
         * @param   array  $params An object containing the module parameters
         *
        * @access public
      */
		
      public static function getHello($params) {
         return 'Hello, World!';
      }
   }
	
?>

Step 3 - Crie um arquivo chamado como mod_helloworld.php. É um ponto de entrada para o módulo que executa rotinas de inicialização, coleta os dados necessários e exibe a saída do módulo usando um modelo.

mod_helloworld.php

<?php
   /**
      * Hello World! Module Entry Point
      *
      * @package    Joomla.Tutorials
      * @subpackage Modules
      * @license    GNU/GPL, see LICENSE.php
      * @link       http://docs.joomla.org/J3.x:Creating_a_simple_module/Developing_a_Basic_Module
      * mod_helloworld is free software. This version may have been modified pursuant
      * to the GNU General Public License, and as distributed it includes or
      * is derivative of works licensed under the GNU General Public License or
      * other free or open source software licenses.
   */

   // No direct access
   defined('_JEXEC') or die;

   // Include the syndicate functions only once
   require_once dirname(__FILE__) . '/helper.php';

   $hello = modHelloWorldHelper::getHello($params);
   require JModuleHelper::getLayoutPath('mod_helloworld');
?>

Step 4 - Crie um mod_helloworld.xml file. Este arquivo contém as informações sobre o módulo. Este arquivo xml contém informações de arquivos que devem ser instalados no Joomla para o módulo.

arquivo mod_helloworld.xml

<?xml version = "1.0" encoding = "utf-8"?>

<extension type = "module" version = "3.1.0" client = "site" method="upgrade">

   <name>Hello, World!</name>
   <author>Tutorials Point</author>
   <version>1.0.0</version>
   <description>A simple Hello World! module.</description>
	
   <files>
      <filename>mod_helloworld.xml</filename>
      <filename module = "mod_helloworld">mod_helloworld.php</filename>
      <filename>index.html</filename>
      <filename>helper.php</filename>
      <filename>tmpl/default.php</filename>
      <filename>tmpl/index.html</filename>
   </files>
	
   <config>
   </config>
	
</extension>

Step 5 - Crie um arquivo html simples chamado index.html. O propósito de escrever este arquivo é que, os diretórios criados não devem ser navegados. Quando um usuário navega por esses diretórios, o arquivo index.html é exibido. Você pode até mesmo manter este arquivo vazio.

index.html

<html>
   <body> Welcome to Tutorials Point!!!!! </body>
</html>

Step 6 - Crie uma pasta chamada como tmpl. Lugar, colocardefault.php arquivo conforme mostrado abaixo e index.html (criado na etapa (5)) em tmplpasta. O arquivo default.php é um modelo que exibe a saída do módulo.

default.php

<?php
   /**
      * @package Joomla.Site
      * @subpackage mod_firstmodule
      * @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
      * @license GNU General Public License version 2 or later; see LICENSE.txt
   */
defined('_JEXEC') or die;
>

<p>Hello World!!!!!!</p>

Depois de terminar de criar todos esses arquivos, compacte a pasta completa mod_firstmodule.

Step 7 - Vá para Extension → Extension Managerno administrador do Joomla e você terá a seguinte tela. Aqui você pode enviar e instalar seus arquivos de módulo criados, ou seja,mod_firstmodulepasta. Clique emChoose Filee selecione o arquivo do módulo criado (compactado). Clique emUpload & Install botão para carregar o arquivo do módulo.

Step 8 - Após o upload e a instalação, vá para Module Manager e clique em New. Lá você pode ver o arquivo do módulo criado, conforme mostrado abaixo.

Step 9 - Você pode atribuir este módulo semelhante aos outros módulos e, em seguida, publicá-lo.

↰ Previous page Next page ↱