CakePHP
  • 文档
    • 书籍
    • API
    • 视频
    • 报告安全问题
    • 隐私政策
    • 标识和商标
  • 商业解决方案
  • 周边商品
  • 公路旅行
  • 团队
  • 社区
    • 社区
    • 参与进来
    • 问题(Github)
    • 烘焙坊
    • 精选资源
    • 培训
    • 聚会
    • 我的 CakePHP
    • CakeFest
    • 时事通讯
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • 帮助和支持
    • 论坛
    • Stack Overflow
    • IRC
    • Slack
    • 付费支持
CakePHP

C CakePHP 5.1 Chiffon API

  • 项目
    • CakePHP
      • CakePHP
      • Chronos
      • Elastic Search
      • 队列
  • 版本
    • 5.1
      • 5.1
      • 5.0
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

命名空间

  • 全局
  • Cake
    • 缓存
    • 集合
    • 命令
    • 控制台
    • 控制器
    • 核心
    • 数据库
    • 数据源
    • 错误
    • 事件
    • 表单
    • HTTP
    • 国际化
    • 日志
    • 邮件
    • 网络
    • ORM
    • 路由
    • 测试套件
    • 工具
    • 验证
    • 视图

命名空间 核心

命名空间

  • Cake\Core\Configure
  • Cake\Core\Exception
  • Cake\Core\Retry
  • Cake\Core\TestSuite

函数详情

deprecationWarning() ¶

deprecationWarning(string $version, string $message, int $stackFrame = 1): void

用于输出弃用警告的辅助方法

参数
string $version

添加此弃用警告的版本。

string $message

作为弃用警告输出的消息。

int $stackFrame 可选

要包含在错误中的堆栈帧。默认值为 1,因为这应该指向应用程序/插件代码。

返回值
void

env() ¶

env(string $key, string|bool|null $default = null): string|float|int|bool|null

从可用来源获取环境变量,并为不支持或不一致的环境变量提供模拟(即 IIS 上的 DOCUMENT_ROOT 或 CGI 模式下的 SCRIPT_NAME)。还公开一些额外的自定义环境信息。

参数
string $key

环境变量名称。

string|bool|null $default 可选

如果未定义环境变量,请指定默认值。

返回值
string|float|int|bool|null
链接
https://book.cakephp.com.cn/5/en/core-libraries/global-constants-and-functions.html#env

h() ¶

h(mixed $text, bool $double = true, string|null $charset = null): mixed

htmlspecialchars 的便捷方法。

参数
mixed $text

要通过 htmlspecialchars 包装的文本。也适用于数组和对象。数组将被映射,所有元素都将被转义。如果对象实现了 __toString 方法,则将被字符串转换。否则,将使用类名。其他标量类型将被原样返回。

bool $double 可选

编码现有的 html 实体。

string|null $charset 可选

转义时要使用的字符集。默认为 mb_internal_encoding() 中的配置值或 'UTF-8'。

返回值
mixed
链接
https://book.cakephp.com.cn/5/en/core-libraries/global-constants-and-functions.html#h

namespaceSplit() ¶

namespaceSplit(string $class): array{0: string, 1: string}

将命名空间从类名中拆分。

通常像 list($namespace, $className) = namespaceSplit($class); 一样使用。

参数
string $class

完整的类名,例如 Cake\Core\App。

返回值
array{0: string, 1: string}

pathCombine() ¶

pathCombine(list<string> $parts, bool|null $trailing = null): string

将部分用正斜杠 / 连接。

如果 / 或 \ 已经存在,则跳过添加正斜杠。

参数
list<string> $parts
bool|null $trailing 可选

确定如何处理尾部斜杠

  • 如果为 true,则确保在不存在的情况下添加尾部正斜杠
  • 如果为 false,则确保删除任何尾部斜杠
  • 如果为 null,则忽略尾部斜杠
返回值
string

pj() ¶

pj(mixed $var): mixed

JSON 漂亮打印便捷函数。

在终端中,这将类似于直接使用带有 JSON_PRETTY_PRINT 的 json_encode(),当不在 CLI 上运行时,还将在给定变量的输出周围包装 <pre> 标签。类似于 pr()。

此函数返回传递的相同变量。

参数
mixed $var

要打印的变量。

返回值
mixed
另请参阅
pr()
链接
https://book.cakephp.com.cn/5/en/core-libraries/global-constants-and-functions.html#pj

pluginSplit() ¶

pluginSplit(string $name, bool $dotAppend = false, string|null $plugin = null): array

将点语法插件名称拆分为其插件和类名。如果 $name 没有点,则索引 0 将为 null。

通常像以下这样使用

list($plugin, $name) = pluginSplit($name);
参数
string $name

要插件拆分的名称。

bool $dotAppend 可选

如果要将插件追加 '.' 设置为 true。

string|null $plugin 可选

如果未找到插件,则要使用的可选默认插件。默认为 null。

返回值
array
链接
https://book.cakephp.com.cn/5/en/core-libraries/global-constants-and-functions.html#pluginSplit

pr() ¶

pr(mixed $var): mixed

print_r() 便捷函数。

在终端中,这将类似于直接使用 print_r(),当不在 CLI 上运行时,print_r() 还将在给定变量的输出周围包装 <pre> 标签。类似于 debug()。

此函数返回传递的相同变量。

参数
mixed $var

要打印的变量。

返回值
mixed
另请参阅
debug()
链接
https://book.cakephp.com.cn/5/en/core-libraries/global-constants-and-functions.html#pr

toBool() ¶

toBool(mixed $value): bool|null

将值转换为布尔值。

1 | '1' | 1.0 | true - 值返回为 true 0 | '0' | 0.0 | false - 值返回为 false 其他值返回为 null。

参数
mixed $value

要转换为布尔值的值。

返回值
bool|null

toFloat() ¶

toFloat(mixed $value): float|null

将值转换为浮点数。

此方法尝试将给定值转换为浮点数。如果转换成功,则将值作为浮点数返回。如果转换失败,则返回 NULL。

字符串值使用 trim() 修剪。

参数
mixed $value

要转换为浮点数的值。

返回值
float|null

toInt() ¶

toInt(mixed $value): int|null

将值转换为整数。

此方法尝试将给定值转换为整数。如果转换成功,则将值作为整数返回。如果转换失败,则返回 NULL。

字符串值使用 trim() 修剪。

参数
mixed $value

要转换为整数的值。

返回值
int|null

toString() ¶

toString(mixed $value): ?string

将给定值转换为字符串。

此方法尝试将给定值转换为字符串。如果值已经是字符串,则按原样返回该值。如果转换不可行,则返回 null。

参数
mixed $value

要转换的值。

返回值
?string

triggerWarning() ¶

triggerWarning(string $message): void

触发 E_USER_WARNING。

参数
string $message

警告消息。

返回值
void

接口

  • ConsoleApplicationInterface

    定义控制台运行器依赖的方法的接口。

  • ContainerApplicationInterface

    配置和使用依赖注入容器的应用程序的接口。

  • ContainerInterface

    CakePHP 应用程序中依赖注入容器的接口

  • HttpApplicationInterface

    定义 HTTP 服务器依赖的方法的接口。

  • PluginApplicationInterface

    利用插件和事件的应用程序的接口。

  • PluginInterface

    插件接口

类

  • App

    App 负责资源定位和路径管理。

  • BasePlugin

    基本插件类

  • Configure

    配置类。用于管理运行时配置信息。

  • Container

    依赖注入容器

  • ObjectRegistry

    充当对象的注册表/工厂。

  • Plugin

    Plugin 用于加载和定位插件。

  • PluginCollection

    插件集合

  • PluginConfig

    PluginConfig 包含所有可用的插件及其配置,如果/如何加载它们

  • ServiceConfig

    配置数据的只读包装器

  • ServiceProvider

    容器服务提供者

Traits

  • ConventionsTrait

    提供允许其他类访问基于约定的词形变化的方法。

  • InstanceConfigTrait

    用于读取和写入实例配置的 Trait

  • StaticConfigTrait

    一个 Trait,它提供一组静态方法来管理为提供适配器外观或需要注册和操作一组配置数据的类配置。

OpenHub
Pingping
Linode
  • 商业解决方案
  • 展示
  • 文档
  • 书籍
  • API
  • 视频
  • 报告安全问题
  • 隐私政策
  • 标识和商标
  • 社区
  • 参与进来
  • 问题(Github)
  • 烘焙坊
  • 精选资源
  • 培训
  • 聚会
  • 我的 CakePHP
  • CakeFest
  • 时事通讯
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • 帮助和支持
  • 论坛
  • Stack Overflow
  • IRC
  • Slack
  • 付费支持

使用 CakePHP API 文档 生成