第十九章-掌握Symfony的配置文件ob娱乐下载

现在您已经非常了解symfony了，ob娱乐下载您已经能够深入研究它的代码来理解它的核心设计并发现新的隐藏功能。但是在扩展symfony类以满足您自己的需求之前，ob娱乐下载您应该仔细查看一些配置文件。symfony中已经内置了许多特性，只需更改配置设置就可以激活它们。ob娱乐下载这意味着您可以在不重写其类的情况下调整symfony核心行为。ob娱乐下载本章将带您深入了解配置文件及其强大的功能。

ob娱乐下载Symfony的设置

的前端/ config / settings.yml文件包含的主要symfony配置ob娱乐下载前端应用程序。在前面的章节中，您已经看到了该文件中许多设置的功能，但让我们重新审视它们。

正如在第5章中所解释的，这个文件是环境相关的，这意味着每个设置可以为每个环境取不同的值。方法可以从PHP代码中访问此文件中定义的每个参数sfConfig类。参数名是设置名的前缀sf_．的值缓存参数，您只需要调用sfConfig: get(“sf_cache”)．

默认模块和动作

ob娱乐下载Symfony为特殊情况提供了默认页面。路由错误时，symfony将执行ob娱乐下载默认的模块中存储的sfConfig: get (sf_ob娱乐下载symfony_lib_dir) /控制器/违约目录中。的settings.ymlFile根据错误定义执行哪个动作:

• error_404_module而且error_404_action:当用户输入的URL与任何路由不匹配时或当路由不匹配时调用的动作sfError404Exception发生。默认值为默认的/那么error404．
• login_module而且login_action:当未经过身份验证的用户试图访问定义为的页面时调用的操作安全在security.yml(详见第六章)。默认值为默认的/登录．
• secure_module而且secure_action:当用户不具备操作所需的凭据时调用的操作。默认值为默认的/安全．
• module_disabled_module而且module_disabled_action:当用户请求声明为禁用的模块时调用的动作module.yml．默认值为默认的/禁用．

在将应用程序部署到生产环境之前，您应该自定义这些操作，因为默认的模块模板包括页面上的symfony标志。ob娱乐下载如图19-1所示为其中一个页面的截图，即错误404页面。

图19-1 -默认的404错误页面

你可以用两种方式覆盖默认页面:

• 您可以在应用程序中创建自己的默认模块模块/目录中定义的所有操作settings.yml文件(指数，那么error404，登录，安全，禁用)及所有相关模版(indexSuccess.php，error404Success.php，loginSuccess.php，secureSuccess.php，disabledSuccess.php)．
• 的默认模块和操作设置settings.yml文件来使用应用程序的页面。

另外两个页面具有symfony外观，在部署到生ob娱乐下载产环境之前也需要对它们进行定制。这些页不在默认的模块，因为它们在symfony不能正常运行时被调用。ob娱乐下载方法中可以找到这些默认页面sfConfig: get (sf_ob娱乐下载symfony_lib_dir) /异常/数据/目录:

• error.html.php:生产环境中发生内部服务器错误时调用的页面。在其他环境中(其中debug设置为真正的)，当发生错误时，symfony会显示完整的执行堆ob娱乐下载栈和显式的错误消息(详见第16章)。
• unavailable.php:当用户在应用程序被禁用时请求页面时调用的页(使用项目:禁用的任务)。方法的调用之间也会在缓存被清除时调用缓存:清晰任务和此任务执行的结束)。在具有非常大缓存的系统上，缓存清理过程可能需要几秒钟。ob娱乐下载Symfony不能执行部分清除缓存的请求，因此在进程结束前收到的请求将被重定向到该页。

要定制这些页面，只需创建错误/ error.html.php而且unavailable.php在您的项目或应用程序中配置/目录中。ob娱乐下载Symfony将使用这些模板而不是自己的模板。

可选特性激活

的一些参数settings.yml文件控制可选的框架特性，可以启用或禁用。禁用未使用的特性会略微提高性能，因此在部署应用程序之前，请确保检查表19-1中列出的设置。

表19-1 -可选特性设置直通settings.yml

功能配置

ob娱乐下载的一些参数settings.yml更改内置功能(如表单验证、缓存和第三方模块)的行为。

输出转义设置

输出转义设置控制变量在模板中的访问方式(参见第7章)settings.yml文件包含此功能的两个设置:

• 的escaping_strategy设置可以取该值真正的,或假．
• 的escaping_method设置可以设置为ESC_RAW，ESC_SPECIALCHARS，ESC_ENTITIES，ESC_JS,或ESC_JS_NO_ENTITIES．

路由设置

路由设置(参见第9章)定义在factories.yml，在路由关键。清单19-1显示了缺省路由配置。

清单19-1 - Routing Configuration Settings, in前端/ config / factories.yml

routing: class: sfPatternRouting参数:load_configuration: true后缀:。Default_module: default default_action: index variable_prefixes: [':'] segment_separators:['/'， '。'] variable_regex: '[\w\d_]+' debug: %SF_DEBUG% logging: %SF_LOGGING_ENABLED% cache: class: sfFileCache param: automatic_cleaning_factor: 0 cache_dir: %SF_CONFIG_CACHE_DIR%/routing lifetime: 31556926 prefix: %SF_APP_DIR%

• 的后缀参数为生成的url设置默认后缀。默认值为句点(．)，并且不对应后缀。设置为. html例如，让所有生成的url看起来像静态页面。
• 属性时，路由规则没有定义模块或者是行动参数的值factories.yml被用来代替:
  • default_module:默认模块请求参数。默认为默认的模块。
  • default_action:默认行动请求参数。默认为指数行动。
• 默认情况下，路由模式通过冒号(：)前缀。但是如果你想用更php友好的语法编写规则，你可以添加$ (＄)在variable_prefixes数组中。这样，你可以写一个像'/article/$year/$month/$day/$title'这样的模式，而不是'/article/:year/:month/:day/:title'。
• 模式路由将识别分隔符之间的已命名通配符。的默认分隔符是斜杠和点，但如果需要，可以在segment_separators参数。例如，如果您添加破折号(-)，你可以这样写:“/article/:year-:month-:day/:title”。
• 模式路由在生产模式下使用自己的缓存来加快外部url和内部uri之间的转换。默认情况下，此缓存使用文件系统，但您可以使用任何缓存类，只要在类中声明类及其设置缓存参数。有关可用缓存存储类的列表，请参阅第15章。要在生产环境中禁用路由缓存，请设置调试参数真正的．

的设置sfPatternRouting类。您可以为应用程序路由使用另一个类，可以是您自己的类，也可以是symfony的路由工厂之一(ob娱乐下载sfNoRouting而且sfPathInfoRouting)．使用这两个工厂中的任何一个，所有外部url看起来都像'module/action?key1=param1'。不可能进行定制，但速度很快。不同之处在于第一个使用PHP的得到，第二种用途PATH_INFO．主要用于后端接口。

还有一个与路由相关的附加参数，但是这个参数存储在settings.yml：

• no_script_name在生成的url中启用前端控制器名称。的no_script_name设置只能对项目中的单个应用程序启用，除非您将前端控制器存储在不同的目录中并更改默认的URL重写规则。它通常对主应用程序的生产环境是打开的，对其他应用程序是关闭的。

表单验证设置

控件输出错误消息的方式验证helper查看(参见第10章)。这些错误包括在< div >标签，他们使用validation_error_类设置为类属性和validation_error_id_prefix设置建立id属性。默认值为form_error而且error_for_，因此属性输出由调用form_error ()的输入foobar将类= " form_error " id = " error_for_foobar "．

有两个设置决定了每个错误消息前面和后面的字符:validation_error_prefix而且validation_error_suffix．您可以将它们更改为一次定制所有错误消息。

缓存设置

中定义了缓存设置cache.yml大多数情况下，除了两个settings.yml：缓存启用模板缓存机制和etag在服务器端启用ETag处理(参见第15章)。您还可以指定用于两个所有缓存系统(视图缓存、路由缓存和i18n缓存)的存储factories.yml．清单19-2显示了默认的视图缓存工厂配置。

清单19-2 - View Cache Configuration Settings, in前端/ config / factories.yml

view_cache: class: sfFileCache param: automatic_cleaning_factor: 0 cache_dir: %SF_TEMPLATE_CACHE_DIR% lifetime: 86400 prefix: %SF_APP_DIR%/template

的类可以是任何一个sfFileCache，sfAPCCache，sfEAcceleratorCache，sfXCacheCache，sfMemcacheCache,sfSQLiteCache．它也可以是您自己的自定义类，前提是它可以扩展sfCache并提供用于设置、检索和删除缓存中的键的相同通用方法。工厂参数取决于你选择的类，但有一些常量:

• 一生定义删除缓存部件后的秒数
• 前缀是添加到每个缓存键的前缀(根据环境使用前缀中的环境来使用不同的缓存)。如果希望两个应用程序的缓存共享，则使用相同的前缀。

然后，对于每个特定的工厂，必须定义缓存存储的位置。

• 为sfFileCache,cache_dir参数定位到缓存目录的绝对路径
• sfAPCCache，sfEAcceleratorCache,sfXCacheCache不带任何位置参数，因为它们使用PHP本地函数与APC, EAccelerator或XCache缓存系统通信
• 为sfMemcacheCache中，输入Memcached服务器的主机名宿主参数中的主机数组服务器参数
• 为sfSQLiteCache，则SQLite数据库文件的绝对路径应在数据库参数

有关其他参数，请查看每个缓存类的API文档。欧宝官网下载app

视图并不是唯一能够使用缓存的组件。这两个路由和I18N工厂提供缓存参数，可以在其中设置任何缓存工厂，就像视图缓存一样。例如，清单19-1所示的路由在默认情况下使用文件缓存作为加速策略，但是您可以将其更改为您想要的任何方式。

日志设置

两个日志记录设置(参见第16章)存储在settings.yml：

• error_reporting指定在PHP日志中记录哪些事件。缺省情况下，为E_parse | e_compile_error | e_error | e_core_error | e_user_error对于生产环境(因此记录的事件是E_PARSE，E_COMPILE_ERROR，E_ERROR，E_CORE_ERROR,E_USER_ERROR)及E_all | e_strict对于开发环境。
• 的web_debug设置激活web调试工具栏。设置为真正的只在开发和测试环境中。

资产路径

的settings.yml文件还存储资源的路径。如果你想使用其他版本的资产，而不是与symfony捆绑的版本，你可以更改这些路径设置:ob娱乐下载

• 管理生成器所需的文件存储在admin_web_dir
• 文件所需的web调试工具栏存储在web_debug_web_dir

默认的助手

为每个模板加载的默认帮助程序在standard_helpers设置(参见第7章)。默认情况下，这些是部分而且缓存辅助组。如果在应用程序的所有模板中使用帮助器组，请将其名称添加到standard_helpers设置为您省去了声明它的麻烦use_helper ()在每个模板上。

激活模块

插件或symfony核心中的激活模块在ob娱乐下载enabled_modules参数。即使一个插件捆绑了一个模块，用户也不能请求这个模块，除非在enabled_modules．的默认的模块，它提供默认的symfony页面(恭喜，页面未找到，等等)，是默认ob娱乐下载情况下唯一启用的模块。

字符集

响应的字符集是应用程序的一般设置，因为框架的许多组件(模板、输出捕获器、帮助程序等等)都使用它。定义在字符集设置时，其默认(和建议)值为utf - 8．

所有:信用卡:假:假# app_creditcards_假签证:真# app_creditcards_visa美国运通:真# app_creditcards_americanexpress

扩展自动加载功能

第2章简要介绍了自动加载特性，如果类位于特定的目录中，则无需在代码中使用它们。这意味着您可以让框架为您完成工作，只允许它在适当的时间加载必要的类，并且只在需要时加载。

的autoload.ymlFile列出了存储自动加载类的路径。第一次处理这个配置文件时，symfony解析文件中引用的所有目录。ob娱乐下载每次文件都以. php，则此文件中的文件路径和类名将被添加到自动加载类的内部列表中。这个列表保存在缓存中，在一个名为配置/ config_autoload.yml.php．然后，在运行时，当使用一个类时，symfony将在此列表中查找类路径并包含ob娱乐下载. php自动文件。

自动加载工作为所有. php包含类和/或接口的文件。

默认情况下，项目中存储在以下目录中的类受益于自动加载:

• myproject / lib /
• myproject / lib /模型
• 前端/ lib / myproject /应用程序
• myproject /应用程序/前端/模块/ mymodule里/ lib

没有autoload.yml文件的默认应用程序配置目录。如果您想修改框架设置——例如，自动加载存储在文件结构其他地方的类——创建一个emptyautoload.yml的设置sfConfig: get (sf_ob娱乐下载symfony_lib_dir) / config / config / autoload.yml或者添加你自己的。

的autoload.yml文件必须以自动装载:输入并列出symfony应该查找类的位置。ob娱乐下载每个位置都需要一个标签;这使您能够覆盖symfony的条目。ob娱乐下载对于每个位置，提供一个的名字(它将作为注释出现在config_autoload.yml.php)和绝对路径．然后定义是否必须进行搜索递归，它指示symfony在所有子目ob娱乐下载录中查找. php文件,排除您需要的子目录。清单19-3显示了默认使用的位置和文件语法。

清单19-3 -默认的自动加载配置，在sfConfig: get (sf_ob娱乐下载symfony_lib_dir) / config / config / autoload.yml

自动加载:# plugins plugins_lib: name: plugins lib路径:%SF_PLUGINS_DIR%/*/lib递归:true plugins_module_lib: name: plugins模块lib路径:%SF_PLUGINS_DIR%/*/modules/*/lib前缀:2递归:true #工程项目:名称:工程路径:%SF_LIB_DIR%递归:true排除:[model, symfony] project_model:名称:工程模型路径:%SF_LIB_DIR%/模型递归:true #应用程序应用程序:名称:应用程序路径:%SF_APP_ob娱乐下载LIB_DIR%递归:true模块:名称:模块路径:%%SF_APP_DIR%/modules/*/lib prefix: 1递归:true

规则路径可以包含通配符，并使用配置类中定义的文件路径参数(请参阅下一节)。如果在配置文件中使用这些参数，它们必须以大写字母出现，并且以％．

编辑自己的autoload.yml将为symfony的自动加载添加新的位置，但您可能希ob娱乐下载望扩展此机制并将自己的自动加载处理程序添加到symfony的处理程序中。因为sob娱乐下载ymfony使用标准spl_autoload_register ()函数来管理类的自动加载，你可以在应用程序配置类中注册更多的回调:

类frontendConfiguration扩展sfApplicationConfiguration｛公共函数初始化（）｛父::初始化（）；//先加载symob娱乐下载fony自动加载//在这里插入你自己的自动加载调用spl_autoload_register（数组（“myToolkit”，自动装载的））；｝｝

当PHP自动加载系统遇到一个新类时，它将首先尝试symfony自动加载方法(并使用中定义的位置ob娱乐下载autoload.yml)．如果它没有找到类定义，则注册的所有其他可调用对象spl_autoload_register ()将被调用，直到找到该类。所以你可以添加任意多的自动加载机制——例如，提供一个到其他框架组件的桥(参见第17章)。

自定义文件结构

每当框架使用一个路径来查找某些东西(从核心类到模板、插件、配置等等)时，它都会使用一个路径变量而不是实际的路径。通过改变这些变量，您可以完全改变symfony项目的目录结构，并适应任何客户端的文件组织需求。ob娱乐下载

文件的基本结构

路径变量定义在sfProjectConfiguration而且sfApplicationConfiguration类，并存储在sfConfig对象。清单19-4显示了路径变量及其引用的目录。

清单19-4 -默认文件结构变量，定义于sfProjectConfiguration而且sfApplicationConfiguration

sf_root_dir # myproject / sf_apps_dir #应用/ sf_app_dir #前端/ sf_app_config_dir # # lib / config / sf_app_i18n_dir # i18n / sf_app_lib_dir sf_app_module_dir #模块/ sf_app_template_dir #模板/ sf_cache_dir #缓存/ sf_app_base_cache_dir #前端/ sf_app_cache_dir #刺激/ sf_template_cache_dir #模板/ sf_i18n_cache_dir # i18n /配置/ sf_test_cache_dir sf_config_cache_dir # #测试/ sf_module_cache_dir #模块/ sf_config_dir #配置/ sf_data_dir #数据/ sf_lib_dir # lib /Sf_log_dir # log/ sf_test_dir # test/ sf_plugins_dir # plugins/ sf_web_dir # web/ sf_upload_dir # uploads/

密钥目录的每个路径都由以结尾的参数确定_dir．始终使用路径变量而不是实际(相对或绝对)文件路径，以便在必要时以后能够更改它们。例如，当您希望将文件移动到上传/目录在一个应用程序中，您应该使用sfConfig: get(“sf_upload_dir”)对于路径而不是sfConfig: get (sf_root_dir)。“/ web /上传/”．

自定义文件结构

如果您为客户端开发应用程序，而客户端已经定义了目录结构，并且不愿意更改目录结构以符合symfony逻辑，那么您可能需要修改默认的项目文件结构。ob娱乐下载通过重写sf_XXX_dir变量与sfConfig，您可以使symfony工作于ob娱乐下载与默认结构完全不同的目录结构。执行此操作的最佳位置是在应用程序中ProjectConfiguration类用于项目目录，或者XXXConfiguration类用于应用程序目录。

例如，如果您希望所有应用程序共享模板布局的公共目录，请将此行添加到设置()方法ProjectConfiguration类来重写sf_app_template_dir设置:

sfConfig::集（“sf_app_template_dir”, sfConfig::得到（“sf_root_dir”）.DIRECTORY_SEPARATOR。“模板”）；

修改项目Web根目录

配置类中构建的所有路径都依赖于项目根目录，该目录由ProjectConfiguration文件包含在前端控制器。通常，根目录高于web /目录，但是您可以使用不同的结构。假设主目录结构由两个目录组成，一个是公共目录，一个是私有目录，如清单19-5所示。这通常发生在在共享主机上托管项目时。

清单19-5 -共享主机自定义目录结构示例

ob娱乐下载symfony/ #私有区域apps/ config/…www/ #公共区域图片/ css/ js/ index.php

在本例中，根目录是ob娱乐下载symfony /目录中。因此,index . php前端控制器只需包含配置/ ProjectConfiguration.class.php申请文件如下:

require_once（目录名（__FILE__）．“/ . ob娱乐下载. / symfony / config / ProjectConfiguration.class.php”）；

此外，使用setWebDir ()方法改变公共区域从通常web /来www /，详情如下:

类ProjectConfiguration扩展sfProjectConfiguration｛公共函数设置（）｛/ /……这个美元->setWebDir（这个美元->getRootDir（）．“/ . . / www”）；｝｝

理解配置处理程序

每个配置文件都有一个处理程序。配置处理程序的任务是管理配置级联，并在运行时在配置文件和优化的PHP可执行代码之间进行转换。

默认配置处理程序

默认处理程序配置存储在sfConfig: get (sf_ob娱乐下载symfony_lib_dir) / config / config / config_handlers.yml．该文件根据文件路径将处理程序链接到配置文件。清单19-6显示了该文件的摘要。

清单19-6 -的提取sfConfig: get (sf_ob娱乐下载symfony_lib_dir) / config / config / config_handlers.yml

配置/设置。yml: class: sfDefineEnvironmentConfigHandler参数:prefix: sf_ config/app. yml: class: sfDefineEnvironmentConfigHandleryml: class: sfDefineEnvironmentConfigHandler参数:prefix: app_ config/filters。class: sfFilterConfigHandler modules/*/config/module. yml: class: sfFilterConfigHandler modules/*/config/module. yml:yml: class: sfDefineEnvironmentConfigHandler param: prefix: mod_ module: yes

对于每个配置文件(config_handlers.yml通过文件路径和通配符标识每个文件)，则处理程序类在类关键。

处理的配置文件的设置sfDefineEnvironmentConfigHandler可以直接在代码中通过sfConfig类，并且参数键包含前缀值。

您可以添加或修改用于处理每个配置文件的处理程序——例如，使用INI或XML文件而不是YAML文件。

如果您需要修改配置的解析方式，请创建一个空的config_handlers.yml在您的应用程序的文件配置/文件夹并重写类与您所编写的类的行。

添加自己的处理程序

使用处理程序处理配置文件提供了两个重要的好处:

• 配置文件被转换为可执行的PHP代码，该代码存储在缓存中。这意味着在生产环境中只解析一次配置，并且性能是最佳的。
• 配置文件可以在不同的级别(项目和应用程序)上定义，最终的参数值将由级联产生。因此，您可以在项目级别定义参数，并在每个应用程序的基础上重写它们。

类中框架使用的结构示例，如果您想编写自己的配置处理程序，请遵循sfConfig:: (sf_symob娱乐下载fony_lib_dir) / config /目录中。

让我们假设您的应用程序包含myMapAPI类，它为交付地图的第三方web服务提供接口。该类需要用URL和用户名初始化，如清单19-7所示。

清单19-7 -实例的初始化myMapAPI类

mapApi美元＝新myMapAPI（）；mapApi美元->setUrl（$ url）；mapApi美元->setUser（$ user）；

您可能希望将这两个参数存储在名为map.yml，位于应用程序中配置/目录中。该配置文件可能包含以下内容:

Api: url: map.api.example.com用户:foobar

为了将这些设置转换为与清单19-7相同的代码，必须构建一个配置处理程序。每个配置处理程序都必须扩展sfConfigHandler并提供execute ()方法，该方法期望将配置文件的文件路径数组作为参数，并且必须返回要写入缓存文件的数据。YAML文件的处理程序应该扩展sfYamlConfigHandler类，它为YAML解析提供了额外的功能。为map.yml文件，典型的配置处理程序可以像清单19-8所示的那样编写。

清单19-8 -自定义配置处理程序，在前端/ lib / myMapConfigHandler.class.php

<？php类myMapConfigHandler扩展sfYamlConfigHandler｛公共函数执行（configfile美元）｛//解析yaml美元配置＝这个美元->parseYamls（configfile美元）；元数据＝“< ?php\ n＂；元数据．＝＂美元\mapApi = new myMapAPI();\ n＂；如果（收取（美元配置［“api”］［“url”］）｛元数据．＝sprintf（＂美元\mapApi - > setUrl (' % s ');\ n＂，美元配置［“api”］［“url”］）；｝如果（收取（美元配置［“api”］［“用户”］）｛元数据．＝sprintf（＂美元\mapApi - > setUser (' % s ');\ n＂，美元配置［“api”］［“用户”］）；｝返回元数据；｝｝

的configfile美元对象的数组ob娱乐下载execute ()方法将包含指向所有map.yml在配置/文件夹。的parseYamls ()方法将处理配置级联。

以便将这个新处理程序与map.yml文件中，必须创建一个config_handlers.yml配置文件，内容如下:

配置/地图。yml:类:myMapConfigHandler

与许多其他symfony配置文件一样，ob娱乐下载您也可以直接在PHP代码中注册配置处理程序:

sfContext:: getInstance () - > getConfigCache()——> registerConfigHandler (' config /地图。yml'， 'myMapConfigHandler'， array());

当您需要的代码基于map.yml文件生成myMapConfigHandler在你的应用程序中，调用下面的行:

包括sfContext::getInstance（）->getConfigCache（）->checkConfig（“配置/ map.yml”）；

当致电checkConfig ()方法，symfoob娱乐下载ny寻找现有的map.yml类中指定的处理程序处理这些文件config_handlers.yml文件，如果map.yml.php缓存中不存在，或者map.yml文件比缓存更新。

配置/地图。yml:类:sfDefineEnvironmentConfigHandler参数:前缀:map_ . yml:类:sfDefineEnvironmentConfigHandler

总结

配置文件可以极大地修改框架的工作方式。因为symfonob娱乐下载y甚至对于其核心功能和文件加载都依赖于配置，所以它可以适应更多的环境，而不仅仅是标准的专用主机。这种出色的可配置性是symfony的主要优势之一。ob娱乐下载尽管它有时会吓到新手(他们在配置文件中看到许多需要学习的约定)，但它允许symfony应用程序与非常多的平台和环境兼容。ob娱乐下载一旦您精通symfony的配置，就没有服务器会拒绝运行您ob娱乐下载的应用程序了!