module development

建立一個自定義的區塊模組, 管理複雜的內容和權限設定 custom block module for complex block content and visability

專為右欄複雜的內容和複雜的顯示設定而建立一個模組管理有幾個好處:

1. 返回NULL 便可以令系統跳過
很方便的就可以處理不顯示的狀態
先檢查顯示與否, 不顯示或權限不足便返回 NULL

2. 源碼管理軟件 (scm) 可以助管理
傳統的 add block 方法將block 內容和顯示的邏輯放到資料庫
不利於 scm 管理
而且使用文件的方式儲存代碼更加有更新容易, 除錯容易等等的優點
身為開發者, 而不是使用者, 有責任為網站提供一個更容易維護的環境

3. 避免將錯誤的PHP 放到資料庫
在顯示設定很多時候都會用到 PHP code
而錯誤的 syntax error 的 PHP code 放到資料庫,
會為頁面不能顯示, 也不可以使用 web 介面修改
要到資料庫中修改, 很麻煩

build a module only for complex blocks have several pros:
1. simple "do not display"
check the visability first,
just return nothing for empty blocks, or access denied cases
system will skip them.

2. Source control management (scm) can help
traditional "add block" method put block content and related visability settings in database
which do not fit with scm.
The use of a module file to store code promotes later updates, easier debugging
Also, as a developer, but not a user, there is a responsibility to provide a better maintainable environment.

3. avoid DB crash upon error php code in database
in visability, PHP is often used
and the syntax errored PHP code will also got stored, and crash the page.
You cannot correct it through web interface,
but have to open a database connection and edit them, very trouble

implement hook_block()

hook_block() 是一個給 Drupal 提供block 的方法
假如你發覺自己在 add block 的時候用了 input method 使用了php
那你其實應該建立一個 module, 使用 hook_block()

原因: "module" vs "add block"

  • php 的 syntax error 不會因為寫進了 DB 而做成修正的極大麻煩 vs 要直接修改 DB record
  • File 方便 version control vs DB record 的 version control 和沒有做差無幾..
  • customization 集中方便修改 vs 源碼分散
  • File deployment vs DB deployment

所以, 不要懶了, 而且建立hook_block() 也很簡單

假設 module 名為 joe >Read more

Drupal 模組開發

模組開發是需要你有 PHP 的開發能力的
一般的想法是, contributed module 做不到我想要的功能
便自己開發一個
但其實, 遇到這樣的情況的機會實在不多
因為 Drupal 的用戶群已經足夠大了, 一般的問題都會有模組解決
但遇到定製的需求, 為了代碼維護性, 完整性, 便免不了需要自己寫一個module 了

Module development - introduction [module].info

要自己建立一個 module, 先要跟從 Drupal 的一些規定
令 Drupal 知道有這麼一個新的 module 存在

假設要寫的是一個名為 my_module 的模組 (真正的模組只可以使用 a 到 z 和 _ )

  1. 先到 sites/all/modules 建立一個資金夾, 名為 my_module
  2. 在資料夾之內建立兩個檔案
    1. my_module.info (模組的基本資料)
    2. my_module.module (模組的 php code)

my_module.info: (只介紹最基本的要求, 以後再補上非必要的設定)

//不需要 <?php
; $Id$
name = "My module"
description = "模組簡介"
core = 6.x

ref: Writing .info files (Drupal 6.x) http://drupal.org/node/231036

而 my_module.module 內基本上沒有必需的內容
但在這個時候便適合介紹 hook 系統了

你會在 Drupal 的教學看到很多 hook_block(), hook_help()
hook 是什麼?
其實, 每一個 module 都可以使用這些 hook 令 Drupal core 可以使用模組提供的功能
在 my_module.module 的例子, 我應該 declare

function my_module_block() {}

作為 "使用 hook_block()", 或者
function my_module_help(){}

作為 hook_help()
"hook" 是要變為你的模組名, 以區分不同模組之下的相同 hook

下一篇會慢慢介紹各個常用的 hook

ref: Creating Modules http://drupal.org/node/206753