如何用drupal7创建模块系列教程1-4

drupal7教程-创建模块系列一：drupal模块教程前言

本教程将会教你如何在drupal7下创建一个模块-module

如果你的目的是将drupal6或者更早版本的drupal模块转化成drupal7版本的，请参考：http://drupal.org/update/modules

模块(module)：指的是一系列函数的集合体，模块将drupal连接起来，并且在drupal安装时提供了附加的功能。读完这个教程，你将可以建立一个基本的block模块，并且可以把它当做更多高级模块的一个模板。

这个教程不准备教你为公共的发布程序写模块。教程也不会包括缓存，或者权限、代码安全方面的议题。这个教程仅仅作为一个切入点，可以扩展你用其他资源的技能。

本教程假设你掌握了以下方面的知识

基本的PHP知识，包括语法和一些PHP对象的概念
6 Z/ f% F2 I  Z7 k$ m基本的关于数据表，数据字段，数据记录和SQL语句的相关知识
安装好一个drupal7
; Z8 \: B  F5 V0 k. u4 Ydrupal的超级管理员权限
可以访问web服务

本教程假设你没有drupal模块方面的认识知识。

9 x3 c( Z& n8 s4 }, u  a
8 Y7 Q" c" }; Y

drupal7教程创建模块系列二：开始创建模块

摘要：模块文件名和模块所在位置本系列介绍怎么创建一个初始的模块文件和目录。命名你的模块创建模块的第一步是先给模块起一个简称。这个简称因为将要用在你模块所包含的所有文件和函数里面，所以，简称必须以字母开头，并且只能包括小写字母和下划线。对于本教程，我们将选择"current_posts"作为模块简称。注意：你一定要遵守这些建议，不要用大写字母在你的模块简称里，因为模块简称将用于模块的文件名字和某个函数的前缀。当你执行一个drupal钩子（钩子将会在后面的教程里介绍）的时候，drupal将会认出你的钩子函数，如果这些钩子跟模块文件名有相同的函数名前缀。还有一点也很重要，就是你的模块的简称不能跟任何你站点正在用的主题有相同的简称。创建一个文件夹和一个模块文件由于我们选择的模块简称是"current_posts", 开始创建模块时，我们需要现在drupal安装路径下创建一个文件夹：sites/all/modules/current_posts。在sites/all/modules/current_posts文件夹里创建一个PHP文件，并且将文件命名为current_posts.module。注意，drupal不会用.php扩展名。drupal非常清楚.module文件使用php写的。在drupal6版本时，sites/all/modules文件夹里放得都是非核心的模块（类似，sites/all/themes文件夹里放的也是非核心主题），从那以后，这个文件夹就放置所有非核心文件。这样做的好处就是，你更容易更新你的核心文件和模块而不必清理你自己定制的模块和文件。并且，当你有一个多站点drupal安装时，这个模块只用于一个特别的站点，你也可以将模块放置到sites/your-site-folder/modules。模块文件以PHP标签开始，不再设置CVS的ID标签在你的模块里。因为drupal.org已经将版本控制系统改为了Git。如果编码的模块给你一个错误的提示信息关于CVS的，那说明模块还没有更新到drupal.org的Git版本系统中。<?php这个模块目前还没有运行，因为模块没有被激活。我们将在后面的教程中激活模块。编码的标准根据编码标准，不要写闭合标签 ?> 。包含闭合标签可能引起一些奇怪的运行时问题在某些特殊服务建立的时候。所有的被直接用在drupal模块里的函数都是被命名为{modulename}_{functionname}的钩子，这里的functionname是一个预定义的函数名后缀。drupal将运行这些函数得到特殊的数据，因此，有了这些定义好的函数名字，drupal就知道哪里去找这些函数。我们一会将介绍钩子。

drupal7教程-创建模块系列三：告诉drupal你的模块信息

摘要：.info文件所有的模块必须有一个'modulename.info'文件, 它包含了模块的基本信息。一般的格式如下：name = Module name
description = A description of what your module does.
core = 7.x对于我们教程中的实例的模块，我们将用current_posts来代替modulename。如果没有.info文件，模块不会显示在模块列表里。以下是实例模块的内容name = Current posts
description = A block module that lists links to recent posts.core = 7.x增加一个名字为current_posts.info的源文件，并且将此文件放在目录sites/all/modules/current_posts下。注意：如果你拷贝或者粘贴这个上面的代码，要确保描述数据中不包含换行。否则，.info文件不会被正确解析。.info文件的细节name (必须)
; o3 r3 A( u2 p+ D5 y显示你模块的名字。它应该遵循drupal的写法标准：仅仅第一个单词的第一个大写字母是大写的（(比如："Example module", 而不是 "example module" 或"Example Module"）。
5 t2 S* v; n$ k" m) c% Y6 k2 _name = Current postsdescription (必须)
一个简洁、合适的描述可以告诉管理员这个模块是起什么作用的。过长的描述会使管理页面很难看，因此请尽量简洁。这个字段长度限制在255个字符。description = A block module that lists links to recent posts.描述也可以链接到文档或者源码。下面的例子展示了链接到作者。它也能链接到Drupal.org的一篇文章。有时候，在线文档其实比readme文件更有好处。description = Domain manager by <ahref="http://5iphp.com">5iphp.com</a>.core (必须)
8 g8 J$ g  y9 ^+ v6 M& Z4 C% N; A你的模块为哪个drupal版本开发。对于drupal7，核心应该是7.x。注意：模块不能写成某个特殊的某个druapl分支的小版本。比如7.x是正确的，而7.2则是不正确的。
* L' h5 \0 t5 X; x) \# x) wcore = 7.xfiles (可选)
drupal现在支持动态代码载入注册。为了支持这个功能，所有的模块必须在.info文件中声明一个包含类和接口描述的代码文件。比如
; c6 x2 t  U% n6 W( Gname = Example module
3 X5 \1 x0 P# t$ V+ `; H2 Qdescription = "Gives an example of a module."
...
files[] = example.test
( A) o# e/ Z: ~% e  t当一个模块被启用，drupal将重新扫描所有生命的文件，并且索引所有它发现的的类和接口。当有权限的时候，这些类会自动被PHP载入。dependencies (可选)
有许多的额外选项会出现在.info文件里。其中之一就是dependencies。如果一个模块的启用依赖于另一个模块，用如下的语法结构列出所有依赖的模块
2 z  Y0 k# q$ |" U3 ?! n2 Jdependencies[] = taxonomy
dependencies[] = comment
对于示例模块，这个选项没有被用到，我们就没有写。如果dependencies被设置，则所有依赖模块被启用以后，你的模块才能启用。package (可选)
如果一个模块有一个package字符，在admin/build/modules页，它将和其他有相同目录的模块列在一起。如果package字符没有设置，模块将被列在“其他”这个目录下。如果你的模块不是非常的完美，不要单独的设置一个package字符。如果拿不定是不是要作为一个package，那么就让这个字段留空。
) r. \" a/ {! t, K+ Ypackage = "Your arbitrary grouping string"
建议package字段用下面列表里的名字
$ n2 x' c$ l; X! _8 L' N% R3 t    Administration
    Commerce
    Development
    Fields
    Media
5 h/ K; j$ [7 G# v6 k0 o) Q    User interface
& B: ]( e* R, |# I# R    Views
' q+ }6 n/ A& O9 j. @3 i; M' ^    Voting (if it uses/requires VotingAPI).info文件还有一些其他很少被用到的选项，在本教程中就不提了。如果想得到更多的细节，请参考http://drupal.org/node/542202检查：
你的模块现在应该出现在模块列表里了。去“模块”菜单并拉到列表的底部，产看"其他"目录。你可以看到模块Current posts。

drupal7创建模块教程系列四：写注释并开始写你的第一个钩子函数

Drupal钩子（hook）描述: hook_help()
在drupal模块中写注释
在模块中写注释是一个好习惯。下面的注释对于任何看到你代码的人都会感觉很清晰。
<?php
3 j* Z' S3 \. X" d/**
: Z5 C" k* Y0 J9 U) M: }; D( Q* @file
' l- f% R; s! t. ?  j5 ]* A block module that displays recent blog and forum posts.
*/
?>
) X8 @( x5 Y7 T4 m& w* }@file 意味着这段注释是针对整个文件的。

转载请注明出处：http://5iphp.com/drupal-tutorial

+ J( }/ Q* L1 H( C2 F
) v2 |, ~4 s/ a7 y: s
2 L7 H% R( i& U. n' d6 j

" A0 L7 o% u7 J8 x! ?