CakePHP - 项目配置
在本章中,我们将了解 CakePHP 中的环境变量、常规配置、数据库配置和电子邮件配置。
配置 CakePHP 默认带有一个配置文件,我们可以根据需要对其进行修改。为此有一个专用文件夹"config"。 CakePHP 带有不同的配置选项。
让我们从了解 CakePHP 中的环境变量开始。
环境变量
环境变量使您的应用程序在不同环境中的工作变得容易。例如,在开发服务器、测试服务器、登台服务器和生产服务器环境中。对于所有这些环境,您都可以使用 env() 函数 来读取所需环境的配置并构建应用程序。
在您的配置文件夹中,您将遇到 config/.env.example。此文件包含将根据您的环境更改的所有变量。首先,您可以在配置文件夹中创建一个文件,即 config/.env,并定义这些变量并使用它们。如果您需要任何其他变量,可以将其放入该文件中。
您可以使用 env() 函数读取您的环境变量,如下所示 −
示例
$debug = env('APP_DEBUG', false);
第一个是您想要的环境变量的名称,第二个值是默认值。如果未找到环境变量的值,则使用默认值。
常规配置
下表描述了各种变量的作用以及它们如何影响您的 CakePHP 应用程序。
Sr.No | 变量名称和说明 |
---|---|
1 | debug 更改 CakePHP 调试输出。 false = 生产模式。未显示任何错误消息、错误或警告。 true = 显示错误和警告。 |
2 | App.namespace 用于查找应用程序类的命名空间。 |
3 | App.baseUrl 如果您不打算将 Apache 的 mod_rewrite 与 CakePHP 一起使用,请取消注释此定义。别忘了也删除你的 .htaccess 文件。 |
4 | App.base 应用程序所在的基本目录。如果为 false,则会自动检测。 |
5 | App.encoding 定义应用程序使用的编码。此编码用于生成布局中的字符集,并对实体进行编码。它应该与为数据库指定的编码值匹配。 |
6 | App.webroot webroot 目录。 |
7 | App.wwwRoot webroot 的文件路径。 |
8 | App.fullBaseUrl 应用程序根目录的完全限定域名(包括协议)。 |
9 | App.imageBaseUrl Web 路径到 webroot 下的公共图像目录。 |
10 | App.cssBaseUrl webroot 下公共 css 目录的 Web 路径。 |
11 | App.jsBaseUrl webroot 下公共 js 目录的 Web 路径。 |
12 | App.paths 配置非基于类的资源的路径。支持插件、模板、语言环境、子键,允许分别定义插件、视图模板和语言环境文件的路径。 |
13 | Security.salt 用于散列的随机字符串。此值在进行对称加密时也用作 HMAC 盐。 |
14 | Asset.timestamp 使用适当的帮助程序时,在资产文件 URL(CSS、JavaScript、图像)末尾附加一个时间戳,该时间戳是特定文件的最后修改时间。有效值为 −
|
数据库配置
可以在 config/app.php 和 config/app_local.php 文件中配置数据库。此文件包含带有提供参数的默认连接,可以根据我们的选择进行修改。
以下代码片段显示了默认参数和值,应根据要求进行修改。
Config/app_local.php
*/ 'Datasources' => [ 'default' => [ 'host' => 'localhost', 'username' => 'my_app', 'password' => 'secret', 'database' => 'my_app', 'url' => env('DATABASE_URL', null), ], /* * The test connection is used during the test suite. */ 'test' => [ 'host' => 'localhost', //'port' => 'non_standard_port_number', 'username' => 'my_app', 'password' => 'secret', 'database' => 'test_myapp', //'schema' => 'myapp', ], ],
让我们详细了解 config/app_local.php 中的每个参数。
host | 数据库服务器的主机名(或 IP 地址)。 |
---|---|
username | 数据库用户名 |
password | 数据库密码。 |
database | 数据库名称。 |
Port | 用于连接到服务器的 TCP 端口或 Unix 套接字。 |
config/app.php
'Datasources' => [ 'default' => [ 'className' => Connection::class, 'driver' => Mysql::class, 'persistent' => false, 'timezone' => 'UTC', //'encoding' => 'utf8mb4', 'flags' => [], 'cacheMetadata' => true, 'log' => false, 'quoteIdentifiers' => false, //'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'], ], ]
让我们详细了解 config/app.php 中的每个参数。
Sr.No | 键 & 描述 |
---|---|
1 | className 表示与数据库服务器的连接的类的完全命名空间类名。此类负责加载数据库驱动程序、提供 SQL 事务机制和准备 SQL 语句等。 |
2 | driver 用于实现数据库引擎所有特性的驱动程序的类名。这可以是使用插件语法的短类名、完整的命名空间名称或构造的驱动程序实例。短类名的示例包括 Mysql、Sqlite、Postgres 和 Sqlserver。 |
3 | persistent 是否使用与数据库的持久连接。 |
4 | encoding 指示在向服务器发送 SQL 语句时要使用的字符集,如"utf8"等。 |
5 | timezone 要设置的服务器时区。 |
6 | init 在创建连接时应发送到数据库服务器的查询列表。 |
7 | loglog 设置为 true 以启用查询日志记录。启用后,查询将在查询日志范围内的调试级别进行记录。 |
8 | quoteIdentifiers 如果您在表或列名称中使用保留字或特殊字符,请设置为 true。启用此设置将导致使用查询生成器构建的查询在创建 SQL 时带有引用标识符。它会降低性能。 |
9 | flags 应传递给底层 PDO 实例的 PDO 常量的关联数组。 |
10 | cacheMetadata 布尔值 true,或包含用于存储元数据的缓存配置的字符串。不建议禁用元数据缓存,否则会导致性能非常差。 |
电子邮件配置
电子邮件可以在文件 config/app.php 中配置。无需在 config/app.php 中定义电子邮件配置。无需它即可使用电子邮件。只需使用相应的方法分别设置所有配置或加载配置数组。电子邮件默认配置是使用 config() 和 configTransport() 创建的。
电子邮件配置传输
通过与交付配置文件分开定义传输,您可以轻松地在多个配置文件中重复使用传输配置。您可以为生产、开发和测试指定多个配置。每个传输都需要一个 className。有效选项如下 −
邮件 − 使用 PHP 邮件函数发送
Smtp −使用 SMTP 发送
调试 − 不发送电子邮件,只返回结果
您可以通过将适当的文件添加到 src/Mailer/Transport 来添加自定义传输(或覆盖现有传输)。传输应命名为 YourTransport.php,其中"Your'"是传输的名称。
以下是电子邮件配置传输的示例。
'EmailTransport' => [ 'default' => [ 'className' => 'Mail', // SMTP 传输中使用以下键 'host' => 'localhost', 'port' => 25, 'timeout' => 30, 'username' => 'user', 'password' => 'secret', 'client' => null, 'tls' => null, 'url' => env('EMAIL_TRANSPORT_DEFAULT_URL', null), ], ],
电子邮件传递配置文件
传递配置文件允许您预定义应用程序中有关电子邮件的各种属性,并为这些设置命名。这样可以节省整个应用程序中的重复工作,并使维护和开发更加容易。每个配置文件都接受多个键。
以下是电子邮件传递配置文件的示例。
'Email' => [ 'default' => [ 'transport' => 'default', 'from' => 'you@localhost', ], ],