模块
Zend Framework 2使用了一个模块系统,因此你可在每个独立模块中组织你主要的应用程序细节代码。上节提到的基本应用提供的模块可以为整个应用程序提供引导启动、错误处理、路由配置。它通常被用来提供应用级的控制器,比如说,应用程序的首页,但我们不打算使用上节教程中看到的默认主页,因为我们想使唱片列表页成为主页,该内容存在于我们的模块中。
我们将放置所有的代码到Album模块中,该模块包含我们的控制器,模型,表单,视图以及配置文件。必要时我们也需要微调我们的应用。
从我们所需要的目录开始。
设置Album模块
在我们服务器根目录的module目录下创建一个名为Album的模块,其包含如下所示的子目录:
zf2-tutorial/
/module
/Album
/config
/src
/Album
/Controller
/Form
/Model
/view
/album
/album
你可以看到Album模块使得不同类型的文件得到分离。包含Album命名空间类的PHP文件保存在src/Album目录下,这样当我们需要时可以拥有多个命名空间。view目录同样也有一个叫作album的子目录以保存我们模块的视图脚本文件。
为了加载和配置一个模块,ZF2使用ModuleManager的类来实现该功能。它将在模块根目录(module/Album)下找寻一个叫作Module.php的文件,并期望在该文件中找到一个叫作Album\Module的类。也就是说,在给定的模块下,类文件将自动使用模块目录名作为作为类的名称空间。
在Album模块中创建Module.php文件:在zf2-tutorial/module/Album目录下创建一个叫作Module.php的文件:
<?php
namespace Album;
class Module
{
public function getAutoloaderConfig()
{
return array(
'Zend\Loader\ClassMapAutoloader' => array(
__DIR__ . '/autoload_classmap.php',
),
'Zend\Loader\StandardAutoloader' => array(
'namespaces' => array(
__NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
),
),
);
}
public function getConfig()
{
return include __DIR__ . '/config/module.config.php';
}
}
ModuleManager将自动为我们调用getAutoLoaderConfig()和getConfig()。
Autoloading files 自动加载文件
我们的getAutoloaderConfig()方法返回了一个兼容ZF2的AutoloaderFactory的数组。这样配置,我们可以添加一个类映射到ClassmapAutoloader中,并且添加了模块的名称空间到StanderdAutoloader中。这个基本的自动加载器需要一个名称空间和一个告知如何找寻名称空间下文件的路径。这是PSR-0标准,因此每个类都可以直接映射到相应的文件。参考PSR-0 rules。
开发阶段,我们不需要通过classmap来加载文件,所以我们为classmap autoloader提供一个空数组即可。
在zf2-tutorial/module/Album目录下创建一个叫作autoload_classmap.php的文件:
<?php return array();
由于这是一个空数组,当自动加载器找寻一个使用Album名称空间的类时,将为我们回滚到StandarAutoLoader。
注意:如果你想使用Composer,你需要创建一个空方法,如getAutoLoaderConfig(){ }并添加如下代码到composer.json中:
"autoload": {
"psr-0": { "Album": "module/Album/src/" }
},
如果你这样做,你需要运行php composer.phar以升级composer自动加载文件。
配置
一旦注册了自动加载器,让我们简单地看一下Album\Module中getConfig()方法的作用。该方法仅简单地加载config/module.config.php配置文件。
在zf2-tutorial/module/Album/config目录下创建一个叫作module.config.php的文件:
<?php
return array(
'controllers' => array(
'invokables' => array(
'Album\Controller\Album' => 'Album\Controller\AlbumController',
),
),
'view_manager' => array(
'template_path_stack' => array(
'album' => __DIR__ . '/../view',
),
),
);
该配置信息将通过ServiceManager传递到相应的组件中。我们需要两个初始配置段:controllers和view_manager。控制器配置段提供了模块提供的控制器列表。我们将需要一个叫作AlbumController的控制器,对应到Album\Controller\Album。控制器键值在所有模块中必须是唯一的,因此我们为模块设置了前缀。
使用view_manager配置段,我们就可以为TemplatePathStack配置添加视图目录位置。该配置可允许模板解析类找寻到存放在Album模块中的view/目录下的视图脚本文件。
通告我们的新模块给应用程序
我们现在需要告知ModuleManager我们的新模块已存在。这个任务交由应用程序的config目录下的application.config.php文件来完成。更新该文件,以使模块配置段包含Album模块,代码如下:
<?php
return array(
'modules' => array(
'Application',
'Album', // <-- Add this line
),
'module_listener_options' => array(
'config_glob_paths' => array(
'config/autoload/{,*.}{global,local}.php',
),
'module_paths' => array(
'./module',
'./vendor',
),
),
);
这样,我们就在Application模块后面添加了Album模块到我们的模块列表中。
现在我们就可以在模块下放置我们自定义的代码啦!