配置¶

数据库配置¶

CakePHP 期待的数据库配置信息位于 app/Config/database.php 文件中。示例数据库 配置文件在 app/Config/database.php.default 。一个完成的配置应该看起来像这样:

class DATABASE_CONFIG {
    public $default = array(
        'datasource'  => 'Database/Mysql',
        'persistent'  => false,
        'host'        => 'localhost',
        'login'       => 'cakephpuser',
        'password'    => 'c4k3roxx!',
        'database'    => 'my_cakephp_project',
        'prefix'      => ''
    );
}

(默认情况下)会使用 $default 连接数组，除非用模型的 $useDbConfig 属性指定了另 外一个连接。例如，如果应用程序除了默认的数据库还有一个额外的遗留数据库，可以创建 一个结构类似于 $default 数组的新的 $legacy 数据库连接数组，然后在适当的模型中设 置 public $useDbConfig = 'legacy';，就可以使用遗留数据库了。

填写配置数组中的键/值对以尽可能满足需求。

datasource

该配置数组的数据源名称。例如：Database/Mysql、Database/Sqlserver、 Database/Postgres、Database/Sqlite。可以使用 plugin syntax 指定要 使用的插件数据源。

persistent

是否使用连接数据库的持久化连接。当使用 SQLServer 时，应当不要启用持久化连接， 因为这会造成难以诊断的崩溃。

host

数据库服务器的主机名(或IP地址)。

login

账号的用户名。

password

账号的密码。

database

该连接要使用的数据库名称。

prefix (可选)

数据库中每个表名的前缀字符串。如果表没有前缀，设置为空字符串。

port (可选)

用于连接服务器的 TCP 端口或 Unix 套接字(socket)。

encoding

指定了发送 SQL 语句到服务器使用的字符集。对除了 DB2 数据库以外的所有数据库， 默认使用数据库的默认编码。如果对 mysql/mysqli 连接想使用 UTF-8 编码，必须 使用不带连字符的’utf8’。

schema

用于 PostgreSQL 数据库设置，指定使用哪个 schema。

unix_socket

用于支持通过 unix 套接字(socket)文件连接的驱动程序。如果使用 PostgreSQL 数据库，并且想使用 unix 套接字，需要将 host 键留空。

ssl_key

SSL 密钥(SSL key)文件的路径(仅为 MySQL 所支持，要求 PHP 5.3.7+)。

ssl_cert

SSL 证书(SSL certificate)文件的路径(仅为 MySQL 所支持，要求 PHP 5.3.7+)。

ssl_ca

SSL 证书颁发机构(SSL certificate authority)文件的路径(仅为 MySQL 所支持， 要求 PHP 5.3.7+)。

settings

一个包含键值对的数组，在建立连接时应当作为 SET 命令发送到数据库服务器。 该选项当前只被 Mysql、Postgres 和 Sqlserver 所支持。

在这个时候，你也许可以看下 CakePHP 的约定 。对表( 以及某些字段)的正确命名让你自动获得一些功能，而且避免配置。例如，如果将表命名为 big_boxes，模型命名为 BigBox，控制器命名为 BigBoxesController，那这一切就能够自动协作了。按照约定，数据库表名应当使用下划线 分隔的小写复数形式 — 例如：bakers、pastry_stores 和 savory_cakes。

额外的类路径¶

偶尔，在同一个系统上的应用程序之间共享 MVC 类库是很有用的。如果想要在两个应用 程序间使用同一个控制器，可以使用 CakePHP 的 bootstrap.php 把这些额外的类引入。

在 bootstrap.php 使用 App::build() 可以定义额外的路径，CakePHP 就会 在这些路径中搜寻类:

App::build(array(
    'Model' => array(
        '/path/to/models',
        '/next/path/to/models'
    ),
    'Model/Behavior' => array(
        '/path/to/behaviors',
        '/next/path/to/behaviors'
    ),
    'Model/Datasource' => array(
        '/path/to/datasources',
        '/next/path/to/datasources'
    ),
    'Model/Datasource/Database' => array(
        '/path/to/databases',
        '/next/path/to/database'
    ),
    'Model/Datasource/Session' => array(
        '/path/to/sessions',
        '/next/path/to/sessions'
    ),
    'Controller' => array(
        '/path/to/controllers',
        '/next/path/to/controllers'
    ),
    'Controller/Component' => array(
        '/path/to/components',
        '/next/path/to/components'
    ),
    'Controller/Component/Auth' => array(
        '/path/to/auths',
        '/next/path/to/auths'
    ),
    'Controller/Component/Acl' => array(
        '/path/to/acls',
        '/next/path/to/acls'
    ),
    'View' => array(
        '/path/to/views',
        '/next/path/to/views'
    ),
    'View/Helper' => array(
        '/path/to/helpers',
        '/next/path/to/helpers'
    ),
    'Console' => array(
        '/path/to/consoles',
        '/next/path/to/consoles'
    ),
    'Console/Command' => array(
        '/path/to/commands',
        '/next/path/to/commands'
    ),
    'Console/Command/Task' => array(
        '/path/to/tasks',
        '/next/path/to/tasks'
    ),
    'Lib' => array(
        '/path/to/libs',
        '/next/path/to/libs'
    ),
    'Locale' => array(
        '/path/to/locales',
        '/next/path/to/locales'
    ),
    'Vendor' => array(
        '/path/to/vendors',
        '/next/path/to/vendors'
    ),
    'Plugin' => array(
        '/path/to/plugins',
        '/next/path/to/plugins'
    ),
));

核心配置¶

每个 CakePHP 应用程序包含一个配置文件 app/Config/core.php ，决定 CakePHP 的 内部行为。这个文件是一个 Configure 类变量和常量定义的集合，决定应用程序的行为。 在我们深入这些特定的变量之前，你需要熟悉 Configure，CakePHP的配置 注册表类。

Configure 类¶

class Configure¶

尽管在 CakePHP 中很少需要配置，有时对应用程序有自己的配置规则还是有用的。过去你 也许在某些文件中定义变量或常量来定义自定义配置值。这么做迫使你在每次需要这些值时 必须引入那个配置文件。

CakePHP 的 Configure 类可以用来保存和读取应用程序或运行时相关的值。当心，这个类 允许在其中保存任何东西，然后在代码的任何部分使用它：明显诱使人打破作为 CakePHP 的设计目的的 MVC 模式。Configure 类的主要目标是保持变量集中在一起，可在许多对象 之间共享。记得尽量保持“约定重于配置”，你就不会打破我们设定好的 MVC 结构了。

这个类可以在应用程序的任何地方以静态方式调用:

Configure::read('debug');

static Configure::write($key, $value)¶

参数

• $key (string) – 要写入的键，可以是 dot notation 值。

• $value (mixed) – 要存储的值。

用 write() 在应用程序的配置中存储数据:

Configure::write('Company.name','Pizza, Inc.');
Configure::write('Company.slogan','Pizza for your body and soul');

备注

$key 参数中使用的 dot notation 可以用来把配置设置组织成符合 逻辑的分组。

上面的例子也可以写成一个调用:

Configure::write(
    'Company',
    array(
        'name' => 'Pizza, Inc.',
        'slogan' => 'Pizza for your body and soul'
    )
);

可以使用 Configure::write('debug', $int) 来动态切换调试和生产模式。这对 与 AMF 或 SOAP 的交互尤其方便，因为调试信息回引起解析的问题。

static Configure::read($key = null)¶

参数

• $key (string) – 读取的键名，可以是 dot notation 值。

用来从应用程序中读取配置数据。默认是 CakePHP 重要的 debug 值。如果提供键，则 返回数据。使用上面的 write() 的例子，可以读取那个数据:

Configure::read('Company.name');    //得到：'Pizza, Inc.'
Configure::read('Company.slogan');  //得到：'Pizza for your body
                                    //and soul'

Configure::read('Company');

//得到：
array('name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul');

如果$key为null，返回Configure中所有的值。如果对应制定的键$key的值不存在，则 返回null。

static Configure::consume($key)¶

参数

• $key (string) – 读取的键名，可以是 dot notation 值。

从Configure读取并删除键。当你想要合并读取和删除值为单一操作时，这比较有用。

static Configure::check($key)¶

参数

• $key (string) – 要检测的键。

检测键/路径是否存在，且值不是 null 。

2.3 新版功能: Configure::check() 是在 2.3 版本中新增的

static Configure::delete($key)¶

参数

• $key (string) – 要删除的键，可以是 dot notation 值。

用来从应用程序中的配置中删除信息:

Configure::delete('Company.name');

static Configure::version¶

返回当前应用程序的 CakePHP 版本。

static Configure::config($name, $reader)¶

参数

• $name (string) – 附加的读取器(reader)的名称。

• $reader (ConfigReaderInterface) – 附加的读取器实例。

在 Configure 类上附加一个配置读取器。然后附加的读取器就可以加载配置文件。 欲知如何读取配置文件，请参见 加载配置文件。

static Configure::configured($name = null)¶

参数

• $name (string) – 要检查的读取器的名称，如果为 null，则返回所有附加的 读取器的列表。

或者检查指定名称的读取器是否附加了，或者得到附加的读取器列表。

static Configure::drop($name)¶

去掉一个连接的读取器对象。

读写配置文件¶

CakePHP 附带两种内置的配置文件读取器。PhpReader 能够读取 PHP 配置 文件，与 Configure 类之前读取的格式相同。IniReader 能够读取 ini 配置文件。欲知 ini 文件的更多细节，请参见 PHP 文档。为了使用核心配置读取器，需要使用 Configure::config() 把它附加到 Configure 类上:

App::uses('PhpReader', 'Configure');
// 从 app/Config 读取配置文件
Configure::config('default', new PhpReader());

// 从其它路径读配置文件。
Configure::config('default', new PhpReader('/path/to/your/config/files/'));

可以有多个附加到 Configure 类的读取器，每个读取不同的配置文件，或者从不同种类的 来源读取。可以用 Configure 类的一些其它方法与附加的读取器交互。要查看附加了哪些 读取器别名，可以使用 Configure::configured() 方法:

// 得到附加的读取器的别名数组。
Configure::configured();

// 检查是否附加了某个特定的读取器
Configure::configured('default');

也可以删除附加的读取器。Configure::drop('default') 方法会删除默认的读取器 别名。以后任何使用该读取器加载配置文件的企图都会失败。

// 使用 'default' 读取器对象加载 my_file.php
Configure::load('my_file', 'default');

Configure::dump('my_config.php', 'default');

Configure::dump('error.php', 'default', array('Error', 'Exception'));

// 保存当前配置在 'default' 缓存的 'user_1234' 键中。
Configure::store('user_1234', 'default');

// 从缓存恢复运行时配置。
Configure::restore('user_1234', 'default');

创建自己的配置读取器¶

既然配置读取器是 CakePHP 可以扩展的部分，就可以在应用程序和插件中创建配置读取器。 配置读取器需要实现 ConfigReaderInterface 接口。该接口定义了 read 方法为唯一必需的方法。如果你真的喜欢 XML 文件，你可以为应用程序创建一个简单 的 Xml 配置读取器:

// 在 app/Lib/Configure/MyXmlReader.php 中
App::uses('Xml', 'Utility');
class MyXmlReader implements ConfigReaderInterface {
    public function __construct($path = null) {
        if (!$path) {
            $path = APP . 'Config' . DS;
        }
        $this->_path = $path;
    }

    public function read($key) {
        $xml = Xml::build($this->_path . $key . '.xml');
        return Xml::toArray($xml);
    }

    // 在 2.3 版本中，还要求 dump() 方法
    public function dump($key, $data) {
        // 保存数据到文件的代码
    }
}

在 app/Config/bootstrap.php 中可以附加这个读取器并使用它:

App::uses('MyXmlReader', 'Configure');
Configure::config('xml', new MyXmlReader());
...

Configure::load('my_xml');

配置读取器的 read() 方法必需返回一个名为 $key 的资源包含的配置信息数组。

interface ConfigReaderInterface¶

定义读取配置数据和在 Configure 类中保存配置数据的类使用的接口。

ConfigReaderInterface::read($key)¶

参数

• $key (string) – 要加载的键名或者标识符。

这个方法应当加载/解析由 $key 标识的配置数据，并返回文件中的数据数组。

ConfigReaderInterface::dump($key, $data)¶

参数

• $key (string) – 要写入的标识符。

• $data (array) – 要保存的数据。

这个方法把提供的配置数据保存到 $key 所指定的键中。

exception ConfigureException¶

在加载/保存/恢复配置数据时，当发生错误时抛出。ConfigReaderInterface 接口的实现在遇到错误时应当抛出这个异常。

词形变化配置¶

CakePHP 的命名约定真的很好 —— 你可以把数据库表命名为 big_boxes，把模型命名为 BigBox，把控制器命名为 BigBoxesController，所有这一切就可以自动在一起运作。 CakePHP 知道如何把这些联结在一起，是通过单词的单数和复数形式之间的词形变化。

偶尔(特别是对我们操非英语的朋友们)，你会遇到 CakePHP 的 Inflector 类(把单词变成复数形式、单数形式、驼峰命名形式和下划线分隔形式的类)不像你希望的 那样进行词形变化。如果 CakePHP 认不出你的 Foci 或者 Fish，你可以告诉 CakePHP 这些特殊情形。

Inflector::rules('singular', array(
    'rules' => array(
        '/^(bil)er$/i' => '\1',
        '/^(inflec|contribu)tors$/i' => '\1ta'
    ),
    'uninflected' => array('singulars'),
    'irregular' => array('spins' => 'spinor')
));

Inflector::rules('plural', array('irregular' => array('phylum' => 'phyla')));

引导启动 CakePHP¶

如果有任何额外的配置需求，可以使用 CakePHP 位于 app/Config/bootstrap.php 的引导 文件。这个文件会在 CakePHP 的核心启动引导后执行。

此文件非常适合用于一些常见的启动任务：

• 定义方便的函数。

• 注册全局常量。

• 定义额外的模型、视图和控制器的路径。

• 创建缓存配置。

• 配置词形变化。

• 加载配置文件。

当向引导文件添加内容时请注意保持 MVC 的软件设计模式：也许会忍不住想把格式化函数 放在那里，从而可以在控制器中使用。

请克制住这种想法。以后你会庆幸你在程序其它的部分这么做的。

你也可以考虑把代码放到 AppController 类中。这个类是应用程序中所有 控制器的父类。AppController 是一个方便的地方，来使用控制器回调， 以及定义供所有控制器使用的方法。