Zend Framework 2模块的正确或首选目录结构是什么?

时间:2012-08-08 11:14:17

标签: php zend-framework2 directory-structure

我想通过将它用于一个小项目来掌握Zend Framework 2。我经历过各种博客文章,文档,当然还有Akrabat(Rob Allen)的精彩教程。

但是,在我的所有阅读中,我都没有对Zend Framework 2期望的模块的正确或首选目录结构进行任何解释。

Akrabat tutorial Rob Allen的示例中,模块使用单个模型和控制器。他选择的目录结构是:

/module
    /Album
        /config
        /src
            /Album
                /Controller
                /Form
                /Model
        /view
            /album
                /album

这一切都很好,但是如果一个模块有多个控制器和模型,就像你在一个有多个页面/部分的网站中所期望的那样呢?我会将所有控制器放在/ src / Album / Controller目录中,还是为每个其他模型及相关控制器和视图创建另一组/ src / xxx /目录?

在/ view目录中,我是否会将其分解为各种控制器使用的每组视图的子目录?

我认为我的困惑来自于Rob的例子中,他的主要控制器/模型与模块的名称相同。因此,他的相册模块有一个目录,其中包含更多用于模型,控制器和视图的相册目录。如果我要将他的模块从专辑重命名为,例如 MyModule ,则目录结构将变为:

/module
    /MyModule
        /config
        /src
            /Album
                /Controller
                /Form
                /Model
        /view
            /MyModule
                /album

那么它是否会遵循一个额外的模型,艺术家,以及相关的控制器将如此组织:

/module
    /MyModule
        /config
        /src
            /Album
                /Controller
                /Form
                /Model
            /Artist
                /Controller
                /Form
                /Model
        /view
            /MyModule
                /album
                /artist

如果不是上述内容,那将是什么结构?

这当然是假设ZF2期望严格的结构。如果情况并非如此,那么显然我可以按照我想要的方式组织它。

1 个答案:

答案 0 :(得分:15)

快速回答你的最后一个问题 - ZF2确实不关心目录结构。或者我应该说 - 它没有预定义的结构。这就是它具有自动加载器配置和类映射的原因(取决于您选择使用哪种方法)。

“默认”自动加载器(请参阅Module.php),您可以在大多数示例中找到它们,只假设您的ModuleName类可以在./src/ModuleName目录中找到:

// ./modules/ModuleName/Module.php
public function getAutoloaderConfig()
{
    return array(
        'Zend\Loader\StandardAutoloader' => array(
            'namespaces' => array(
                __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
            ),
        ),
    );
}

我假设您知道那些__NAMESPACE__部分的含义。

因此,如果您有一个名为Cat的模块,则可以在./modules/Cat/src/Cat中找到它的类。

如果您决定在应用程序中添加一些新功能,则需要添加另一个名为Dog的模块,并将其类文件放在./Dog/src/Dog中。

但是,这绝不意味着你必须这样做。您还可以将所有与动物相关的类放在一个名为Animals。您必须修改自动加载器,如下所示:

// ./modules/Animals/Module.php
public function getAutoloaderConfig()
{
    return array(
        'Zend\Loader\StandardAutoloader' => array(
            'namespaces' => array(
                'Cat' => __DIR__ . '/src/Cat',
                'Dog' => __DIR__ . '/src/Dog',
            ),
        ),
    );
}

...并将您的课程放在./modules/Animal/src/Cat/Persian.php./modules/Animal/src/Dog/Collie.php等文件中。

我建议的一件事是将模块视为单独的实体,而不了解其他模块的具体内容。作为一个“真实”的例子 - 我有一个应用程序,它有一个前端(html,css等)和API功能。

我有3个模块:

  • Application - 包含数据库配置,db表类,映射器,模型,身份验证类等。基本上是任何其他模块可能需要的所有内容。
  • Api - 让控制器期望以特定格式发出请求并将其输出为例如JSON(即不需要视图)。这个模块中的类正在使用Application模块中的类,因为我仍然需要所有的数据库功能,但是将它们全部分开使我能够将应用程序范围的逻辑与API逻辑分开。我可以把这个模块撕掉,但我不想破坏它。
  • Website - 仅负责渲染页面的模块。再一次,它使用了应用程序中的类,因为我希望能够从数据库中呈现数据并让用户编辑它,但我不希望仅在此模块中使用该功能,因为Api也需要它。

我的./config/application.config.php按此顺序加载:

return array(
    'modules' => array(
        'Application',
        'Api',
        'Website',
    ),
    // all other entries
);

这意味着我可以从所有其他模块访问Application类。如果我出于某种原因想要禁用我的API,我会删除Api目录,我的前端仍然可以工作。

希望这有帮助! :)

TL; DR 您可以以任何方式构建文件,只是不要忘记正确配置自动加载器。