symfony文件结构说明

一个symfony项目的结构树是相同的，通过它可以完全定制。这个章节将会帮助你熟悉这个组织结构，并理解内部的逻辑关系。

介绍
所有的web项目通常共享的相同的结构部分：

数据库
静态文件 (HTML, images, javascripts, stylesheets, etc.)
站点用户和管理员上传的文件
PHP的类和库文件
外部库类
批处理文件
日志文件
配置文件
等等.
为了允许开发人员改编任何现有的symfony项目，建议按照下面默认的树结构进行创建目录。这样做也能够加速创建项目，当初始化每一个项目、应用程序或模块的时候就从默认的树结构自动的创建。

根目录的树结构
这是一个Symfony项目的根目录结构：

apps/
  fo/
  bo/
batch/
cache/
config/
data/
  sql/
doc/
  api/
lib/
  model/
log/
test/
web/
  css/
  images/
  js/
  uploads/

batch 目录用于存放调用命令行或调度程序运行批处理操作的php文件。

项目的缓存，用于加速应答web请求，存放在 cache 目录下。每一个应用程序会有一个单独的子目录，包含预处理的HTML和配置文件。

项目的常规配置文件存放在 config 目录下。

在 data 目录下，储存项目的数据资料文件，例如数据库规划资料，创建表的SQL文件，或者如果需要的话可以把 SQLite 数据库放在这里。

doc 目录用于存放项目文档，包括你自己的文档和由 phpdoc （在 api 子目录下）生成的文档。

lib 目录是专门用于存放外部类和库。这里你可以加入在你需要共享的的某个应用程序的代码。 model 子目录用于存放项目的对象模型。

log 目录用于存放由symfony直接产生的日志文件。也可以包括网站的日志文件，数据库日志文件或者项目任意部分的日志文件。这里通常每个环境下的应用对应一个日志文件（例如： myapp_prod.log）。

test 目录包含PHP写的单元测试和兼容 简单测试 的框架测试。 在项目设置期间，Symfony自动加入一些基础测试的结果。

web 目录是网站的根目录。这里只存放需要从Internet可以访问到的文件。之后将会再详细介绍。

最后但同样重要的， apps 目录中都是项目中的每一个应用程序对应的目录（代表性的 fo 和 bo 目录负责前端表现和后端事务， myapp 是实例）。

应用程序的树结构
所有应用程序的目录树结构应该像这样：

config/
i18n/
lib/
modules/
templates/
  layout.php
  error.php
  error.txt

config 目录存放一套设置 YAML 相关的配置文件。这是一个大多数应用程序的配置，从默认的参数分离能够被框架自己创建。注意默认的参数设置如果需要的话仍然能被忽略。你可以在 下一章 找到更多的应用程序配置。

i18n 目录存放的文件用于应用程序的国际化。这些文件应该符合 XLIFF（构建本地化数据交换的标准） 或者 GetText 格式规范。如果你选择了数据库进行国际化就可以忽略这个目录。

lib 目录存放针对具体应用的库类。

modules 目录存放所有包含特殊应用的模块

templates 目录列出了应用的全局模板文件，每一个模板都是被所有的模块共享的。缺省的，它包含一个名为 layout.php 的文件，作为用于模块模版的加入的总体布局文件；一个 error.php 文件，用于在一个页面请求上输出错误；和一个 error.txt 文件用于当调用一个没有浏览表示页面的应用（例如单元测试期间的实例）时输出错误信息。其他的全局模板都能够在这里增加 - 例如如果你的应用程序用到了相同布局的弹出窗口，你可以增加一个 popuplayout.php 文件用于共享。

在一个新的应用上目录 i18n, lib 和 modules 都是空的。

一个应用的目录名在设置的时候就应该被决定，这个名称应该是可以被 sfConfig 对象所理解的，参考：sfConfig::get('sf_app_dir')。

一个应用的类中的方法和属性不能够被这一项目中的其他应用所访问。因此注意，超链接在一个项目中的两个应用之间时必须使用绝对路径。

模块的树结构
每一个应用程序包含一个或多个模块。每一个模块在 modules 目录中都有它自己的子目录，这个子目录的名称在设置期间需要被选定。

这是一个典型的模块树结构：

actions/
  actions.class.php
config/
lib/
templates/
  indexSuccess.php
validate/

actions 目录通常包含一个名为 actions.class.php 的简单类，在这里你可以储存模块的所有行为。一个模块不同的行为也可以写在单独的文件里。

config 目录可以包含定义模块的局部参数的配置文件。

lib 目录包含针对模块的类和库。

templates 目录包含模块行为相对应的模版。在模块设置期间会创建一个默认的模板，也就是在访问 indexSuccess.php时。

还有 validate 目录是专门用于表单确认时的配置文件。

在一个新的应用上目录 config, lib 和 validate 都是空的。

网站的树结构
针对 web 目录有很少的约束，但是以下几个基本命名规则将有助于在模版中使用默认行为和快捷路径。

按照惯例，静态文件被存放在以下目录中：

css/: stylesheets .css为扩展名的样式文件
js/: javascripts .js为扩展名的js脚本文件
images/: images .jpg, .png or .gif 格式的图片文件
用户上传得文件必须存放在 uploads 目录中。然而很多时候， uploads 目录下也会存放图片，这是专门存放图片的目录，因此在开发改进产品的时候不会影响到上传得图片。

定制树结构
虽然强烈建议保持默认的树结构，但是有时候为了特殊需要可能需要改变它，例如为了匹配已经有它自己的树结构和编码规范的一个客户端需求。

在一个应用中定制树结构，你只需要简单得修改应用目录中的配置文件 config/constants.php，将配置文件中把每个路径对应的key目录名（由参数决定）后加上 _dir。这个文件没有被提供在默认的树结构中，如果你需要就要从symfony目录中复制它 - 在 配置章节 有详细的解释说明。下面有一个标准配置文件的范例：

// root directory structure
'sf_cache_dir_name'   => 'cache',
'sf_log_dir_name'     => 'log',
'sf_lib_dir_name'     => 'lib',
'sf_model_dir_name'   => 'model',
'sf_web_dir_name'     => 'web',
'sf_data_dir_name'    => 'data',
'sf_config_dir_name'  => 'config',
'sf_apps_dir_name'    => 'apps',

// global directory structure
'sf_app_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.'apps'.DIRECTORY_SEPARATOR.$sf_app,
'sf_model_dir'      => $sf_root_dir.DIRECTORY_SEPARATOR.'model',
'sf_lib_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.'lib',
'sf_web_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.'web',
'sf_upload_dir'     => $sf_root_dir.DIRECTORY_SEPARATOR.'web'.DIRECTORY_SEPARATOR.'uploads',
'sf_base_cache_dir' => $sf_root_dir.DIRECTORY_SEPARATOR.'cache'.DIRECTORY_SEPARATOR.$sf_app,
'sf_cache_dir'      => $sf_root_dir.DIRECTORY_SEPARATOR.'cache'.DIRECTORY_SEPARATOR.$sf_app.DIRECTORY_SEPARATOR.$sf_environment,
'sf_log_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.'log',
'sf_data_dir'       => $sf_root_dir.DIRECTORY_SEPARATOR.'data',
'sf_config_dir'     => $sf_root_dir.DIRECTORY_SEPARATOR.'config',
名字和路径在这里被定义。虽然这个文件不像上面的这么简单，但你只需要简单的像这样修改就可以了。

重点：强烈建议在建立项目和编码的时候使用这些参数（在 sfConfig 对象中）代替它们的值。这样做，在树结构中创建应用可以独立进行，在第一级目录中就可以明显区分出来。

[php]
// always prefer
if(file_exists(sfConfig::get('sf_log_dir').'myLogFile.log'))
// instead of
if(file_exists('/home/myproject/log/myLogFile.log'))

实例：你的文件系统可以像这个结构（这是一个标准的共享主机系统）：

cgi-bin/
  apps/
    fo/
    bo/
  batch/
  cache/
  config/
  data/
    sql/
  doc/
    api/
  lib/
    model/
  log/
  test/
public_html/
  css/
  images/
  js/
  uploads/
在文件 config/constants.php 中加入下列行：sfConfig::add(array(
  // root directory names
  'sf_exec_dir_name'    => $sf_exec_dir_name   = 'cgi-bin',
  'sf_apps_dir_name'    => $sf_apps_dir_name   = 'apps',
  'sf_bin_dir_name'     => $sf_bin_dir_name    = 'batch',
  'sf_cache_dir_name'   => $sf_cache_dir_name  = 'cache',
  'sf_config_dir_name'  => $sf_config_dir_name = 'config',
  'sf_data_dir_name'    => $sf_data_dir_name   = 'data',
  'sf_doc_dir_name'     => $sf_doc_dir_name    = 'doc',
  'sf_lib_dir_name'     => $sf_lib_dir_name    = 'lib',
  'sf_log_dir_name'     => $sf_log_dir_name    = 'log',
  'sf_test_dir_name'    => $sf_test_dir_name   = 'test',
  'sf_web_dir_name'     => $sf_web_dir_name    = 'public_html',
  'sf_upload_dir_name'  => $sf_upload_dir_name = 'uploads',

  // global directory structure
  'sf_app_dir'        => $sf_app_dir = $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_apps_dir_name.DIRECTORY_SEPARATOR.$sf_app,
  'sf_bin_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_bin_dir_name,
  'sf_base_cache_dir' => $sf_base_cache_dir = $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_cache_dir_name.DIRECTORY_SEPARATOR.$sf_app,
  'sf_cache_dir'      => $sf_cache_dir      = $sf_base_cache_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_environment,
  'sf_config_dir'     => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_config_dir_name,
  'sf_data_dir'       => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_data_dir_name,
  'sf_lib_dir'        => $sf_lib_dir = $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_lib_dir_name,
  'sf_log_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_log_dir_name,
  'sf_test_dir'       => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.$sf_test_dir_name,
  'sf_web_dir'        => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_web_dir_name,
  'sf_upload_dir'     => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_web_dir_name.DIRECTORY_SEPARATOR.$sf_upload_dir_name,

  // lib directory names
  'sf_model_dir_name'      => $sf_model_dir_name      = 'model',
  'sf_plugin_lib_dir_name' => $sf_plugin_lib_dir_name = 'plugins',

  // lib directory structure
  'sf_model_lib_dir'  => $sf_lib_dir.DIRECTORY_SEPARATOR.$sf_model_dir_name,
  'sf_plugin_lib_dir' => $sf_lib_dir.DIRECTORY_SEPARATOR.$sf_plugin_lib_dir_name,

  // data directory names
  'sf_plugin_data_dir'  => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.'data'.DIRECTORY_SEPARATOR.'plugins',

  // data directory structure
  'sf_plugin_dir' => $sf_root_dir.DIRECTORY_SEPARATOR.$sf_exec_dir_name.DIRECTORY_SEPARATOR.'lib'.DIRECTORY_SEPARATOR.'plugins',

  // SF_CACHE_DIR directory structure
  'sf_template_cache_dir' => $sf_cache_dir.DIRECTORY_SEPARATOR.'template',
  'sf_i18n_cache_dir'     => $sf_cache_dir.DIRECTORY_SEPARATOR.'i18n',
  'sf_config_cache_dir'   => $sf_cache_dir.DIRECTORY_SEPARATOR.$sf_config_dir_name,
  'sf_test_cache_dir'     => $sf_cache_dir.DIRECTORY_SEPARATOR.'test',
  'sf_module_cache_dir'   => $sf_cache_dir.DIRECTORY_SEPARATOR.'modules',

  // SF_APP_DIR sub-directories names
  'sf_app_i18n_dir_name'     => $sf_app_i18n_dir_name     = 'i18n',
  'sf_app_config_dir_name'   => $sf_app_config_dir_name   = 'config',
  'sf_app_lib_dir_name'      => $sf_app_lib_dir_name      = 'lib',
  'sf_app_module_dir_name'   => $sf_app_module_dir_name   = 'modules',
  'sf_app_template_dir_name' => $sf_app_template_dir_name = 'templates',

  // SF_APP_DIR directory structure
  'sf_app_config_dir'   => $sf_app_dir.DIRECTORY_SEPARATOR.$sf_app_config_dir_name,
  'sf_app_lib_dir'      => $sf_app_dir.DIRECTORY_SEPARATOR.$sf_app_lib_dir_name,
  'sf_app_module_dir'   => $sf_app_dir.DIRECTORY_SEPARATOR.$sf_app_module_dir_name,
  'sf_app_template_dir' => $sf_app_dir.DIRECTORY_SEPARATOR.$sf_app_template_dir_name,
  'sf_app_i18n_dir'     => $sf_app_dir.DIRECTORY_SEPARATOR.$sf_app_i18n_dir_name,

  // SF_APP_MODULE_DIR sub-directories names
  'sf_app_module_action_dir_name'   => 'actions',
  'sf_app_module_template_dir_name' => 'templates',
  'sf_app_module_lib_dir_name'      => 'lib',
  'sf_app_module_view_dir_name'     => 'views',
  'sf_app_module_validate_dir_name' => 'validate',
  'sf_app_module_config_dir_name'   => 'config',
  'sf_app_module_i18n_dir_name'     => 'i18n',
));