Joomla-モジュールの作成
この章では、 Creating ModulesJoomlaで。モジュールは、柔軟性と軽量性を備え、ページのレンダリングに役立つ拡張機能です。
モジュールの作成
以下は、Joomlaでモジュールを作成するための簡単な手順です。
Step 1 −というフォルダを作成します mod_firstmodule あなたの中で Joomla → modules フォルダ。
Step 2 −で mod_firstmoduleフォルダは「helper.php」という名前のファイルを作成します。このファイルにはヘルパーとしてクラス名が含まれており、取得したデータをモジュール出力に表示するのに役立ちます。
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 −と呼ばれるファイルを作成します mod_helloworld.php。これは、初期化ルーチンを実行し、必要なデータを収集し、テンプレートを使用してモジュール出力を表示するモジュールのエントリポイントです。
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 −作成する mod_helloworld.xml file。このファイルには、モジュールに関する情報が含まれています。このxmlファイルには、モジュール用にJoomlaにインストールされるファイルの情報が含まれています。
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 −という単純なhtmlファイルを作成します index.html。このファイルを作成する目的は、作成されたディレクトリを参照しないことです。ユーザーがこれらのディレクトリを参照すると、index.htmlファイルが表示されます。このファイルを空のままにしておくこともできます。
index.html
<html>
<body> Welcome to Tutorials Point!!!!! </body>
</html>
Step 6 −という名前のフォルダを作成します tmpl。場所default.php 以下に示すファイルとindex.html(ステップ(5)で作成)の下 tmplフォルダ。default.phpファイルは、モジュール出力を表示するテンプレートです。
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>
これらすべてのファイルの作成が完了したら、フォルダー全体を圧縮します mod_firstmodule。
Step 7 −に移動 Extension → Extension ManagerJoomla管理者で、次の画面が表示されます。ここで、作成したモジュールファイルをアップロードしてインストールできます。mod_firstmoduleフォルダ。クリックChoose File作成したモジュールファイル(圧縮ファイル)を選択します。クリックUpload & Install モジュールファイルをアップロードするボタン。
Step 8 −アップロードとインストール後、 Module Manager をクリックします New。作成したモジュールファイルを以下のように表示できます。
Step 9 −このモジュールを他のモジュールと同様に割り当てて、公開することができます。