Drupal模塊開發(fā)步驟

導(dǎo)航: 上一頁(yè) | 首頁(yè) | DedeCMS | 帝國(guó)CMS | Xoops | SupeSite | PHPCMS | PHP168 | Joomla

這里是根據(jù)drupal開發(fā)指南上的例子來(lái)展開的。準(zhǔn)備定制一個(gè)“annotate”模塊。采用Drupal 6版本。

第一步：創(chuàng)建文件。

首先為我們模塊選擇一個(gè)名稱，“annotate”比較適合我們的需求，因?yàn)槠浜?jiǎn)短并能夠讓人能夠大致看出這個(gè)模塊是做什么的。接著，我們需要一個(gè)目錄來(lái)存放這個(gè)模塊?？梢苑旁诤诵哪K一起，但那樣不利于管理和升級(jí)，所以我們放在sites/all/modules內(nèi)。

創(chuàng)建info文件，這個(gè)文件是模塊必須的。用于說(shuō)明模塊的一些基本信息。我們的annotate.info文件內(nèi)容如下：

; $Id$
name = Annotate
description = Allows users to annotate nodes.
core = 6.x
package = Pro Drupal Development

說(shuō)明：文件是簡(jiǎn)單的keys和values格式。以CVS標(biāo)識(shí)標(biāo)簽開始，若你想將模塊貢獻(xiàn)到drupal官方，就需要寫這個(gè)。這個(gè)值將自動(dòng)被CVS替代。接著我們向Drupal提供模塊名稱和描敘，它們將顯示在模塊管理界面上。再接下來(lái)聲明的是我們的模塊兼容drupal那個(gè)版本。模塊是以組的形式顯示，組是由包決定的。因此，若我們有三個(gè)不同的模塊，則是這樣的：package = Pro Drupal Development。它們將顯示在一組。除了上面列出的外，我們還可以添加一些可選項(xiàng)。下面的例子是一個(gè)模塊需要PHP5.2和論壇模塊、分類模塊。

; $Id$
name = Forum confusion
description = Randomly reassigns replies to different discussion threads.
core = 6.x
dependencies[] = forum
dependencies[] = taxonomy
package = "Evil Bob's Forum BonusPak"
php = 5.2

現(xiàn)在來(lái)創(chuàng)建模塊主文件annotate.module。代碼如下：(開始于一個(gè)PHP開始標(biāo)簽和一個(gè)CVS標(biāo)識(shí)標(biāo)簽，接著是一個(gè)注釋)

<?php
// $Id$
/**
* @file
* Lets users add private annotations to nodes.
*
* Adds a text field when a node is displayed
* so that authenticated users may make notes.
*/

注意下注釋風(fēng)格。我們以/**開始，在隨后的行中，我們使用的是*，并縮進(jìn)了一個(gè)空格和以*/結(jié)束注釋。@file表示下一行描敘的是這個(gè)文件是做什么的。使用了這個(gè)單行描敘，因此api.module，drupal文檔自動(dòng)提取器和格式器將能夠找出這個(gè)文件是做什么的。接著一個(gè)空行，我們添加一個(gè)長(zhǎng)句描敘主要是針對(duì)檢查我們代碼的程序員。

注意：我們故意不使用一個(gè)閉合(?>)標(biāo)簽。這在PHP內(nèi)是可選的。若包含了的話，有可能在文件內(nèi)產(chǎn)生尾部空格問(wèn)題。