首页>PHP源码>其他类别
下载

关于

clausnz/php-helpers库是45 个有用的 php 辅助函数(PHP 5.6, 7.*)的集合。
使用composer安装后，可以从代码中的任何位置访问全局函数：

安装

composer require clausnz/php-helpers

例子

 <?php

dump ( ' any content ' );

如果项目定义函数（内置函数和用户定义函数）列表中已存在同名函数，则该函数将不会在您的环境中注册。因此，不会出现与现有功能的冲突。

尽管如此，每个函数仍然可以通过正确的 use 语句以静态方式访问它：

例子

 <?php

use CNZ  Helpers  Util as util ;

util:: dump ( ' any content ' );

学分

该库利用了以下出色且众所周知的库：

  • https://github.com/serbanghita/Mobile-Detect
  • https://github.com/JayBizzle/Crawler-Detect
  • https://github.com/mustangostang/spyc

测试

所有功能都针对多个单元测试和 PHP 版本进行了测试。

安装

使用 Composer 安装最新的clausnz/php-helper库： 

composer require clausnz/php-helpers

还要确保需要您的作曲家自动加载文件： 

 require __DIR__ . ' /vendor/autoload.php ' ;

安装后，新的全局 PHP 函数在您的代码中随处可用。要访问帮助器类中的（几乎相同的）静态函数，请将正确的 use 语句添加到您的文件中：

例子

 <?php

use CNZ  Helpers  Dev as dev ;

if ( dev:: isIphone () ) {
   // Do something here
}

可用的 PHP 函数

目录

  • 设备
    • is_mobile
    • is_智能手机
    • 是_平板电脑
    • 是桌面
    • 是机器人
    • is_ios
    • 是_android
    • 是_iphone
    • 是_三星
  • 大批
    • 数组获取
    • 数组集
    • 数组优先
    • 数组最后一个
    • 到数组
    • 对象
    • is_assoc
  • 细绳
    • 之前的str_
    • 字符串之后
    • str_after_last
    • 字符串之间
    • 字符串插入
    • 字符串限制
    • 字符串限制字数
    • 字符串包含
    • str_icontains
    • str_starts_with
    • str_istarts_with
    • str_ends_with
    • str_iends_with
  • 实用工具
    • ip
    • 是_电子邮件
    • 倾倒
    • DD
    • 密码密码
    • 是_密码
  • yml
    • to_yml
    • 到_yml_文件
    • yml_解析
    • yml_解析文件
    • is_yml
    • is_yml_文件
    • yml_get
    • yml_get_file
    • yml_set
    • yml_set_file

API文档

目录

  • 到达
    • 是关联
    • 对象
    • 倾倒
    • 第一的
    • 最后的
    • 得到
    • 放
  • 开发者
    • 是智能手机
    • 是移动
    • 移动检测
    • 是平板电脑
    • 是桌面
    • 是机器人
    • 爬虫检测
    • 是Android
    • 是iPhone
    • 是三星
    • IOS
  • 斯特
    • 插入
    • 之间
    • 后
    • 前
    • 限制字数
    • 限制
    • 包含
    • 包含忽略大小写
    • 开始于
    • 以忽略大小写开头
    • 结束于
    • 以忽略大小写结尾
    • 最后之后
  • 效用
    • 是电子邮件
    • ip
    • 加密密码
    • 是密码
    • DD
    • 倾倒
  • yml
    • 有效文件
    • 有效
    • 解析
    • 得到
    • 获取文件
    • 解析文件
    • 设置文件
    • 转储文件
    • 倾倒
    • 放

到达

Helper 类提供对有用的 php 数组函数的轻松访问。

类到达

  • 全名：CNZHelpersArr

是关联

检测给定值是否是关联数组。 

Arr:: isAssoc ( array $ array ): boolean

is_assoc

相关的全局函数（说明见上文）。

（向后跳） 

 is_assoc ( array $ array ): boolean

例子

 $ array = [
    ' foo ' => ' bar '
];

is_assoc ( $ array );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$array大批任何类型的数组。

返回值：

如果数组是关联的，则为 true，否则为 false。

对象

将数组转换为对象。 

Arr:: toObject ( array $ array ): object| null

对象

相关的全局函数（说明见上文）。

（向后跳） 

 to_object ( array $ array ): object| null

例子

 $ array = [
    ' foo ' => [
         ' bar ' => ' baz '
    ]
];

$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;

// baz
  • 该方法是静态的。参数：
范围类型描述
$array大批要转换的数组。

返回值：

转换后的数组的 std 对象表示形式。

倾倒

将字符串或对象转换为数组。 

Arr:: dump ( string|object $ var ): array| null

到数组

相关的全局函数（说明见上文）。

（向后跳） 

 to_array ( string|object $ var ): array| null

示例 1（字符串） 

 $ var = ' php ' ;
to_array ( $ var );

// (
//     [0] => p
//     [1] => h
//     [2] => p
// )

示例2（对象） 

 $ var = new stdClass ;
$ var -> foo = ' bar ' ;

to_array ( $ var );

// (
//     [foo] => bar
// )
  • 该方法是静态的。参数：
范围类型描述
$var字符串|对象字符串或对象。

返回值：

转换后的字符串或对象的数组表示形式。出错时返回 null。

第一的

返回数组的第一个元素。 

Arr:: first ( array $ array ): mixed

数组优先

相关的全局函数（说明见上文）。

（向后跳） 

 array_first ( array $ array ): mixed

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

array_first ( $ array )

// bar
  • 该方法是静态的。参数：
范围类型描述
$array大批相关数组。

返回值：

第一个元素的值，没有键。混合型。

最后的

返回数组的最后一个元素。 

Arr:: last ( array $ array ): mixed

数组最后一个

相关的全局函数（说明见上文）。

（向后跳） 

 array_last ( array $ array ): mixed

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

array_last ( $ array )

// qux
  • 该方法是静态的。参数：
范围类型描述
$array大批相关数组。

返回值：

最后一个元素的值，没有键。混合型。

得到

通过键的点表示法获取数组中的值。 

Arr:: get ( string $ key , array $ array ): mixed

数组获取

相关的全局函数（说明见上文）。

（向后跳） 

 array_get ( string key, array $ array ): mixed

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_get ( ' baz.qux ' , $ array );

// foobar
  • 该方法是静态的。参数：
范围类型描述
$key细绳密钥采用点表示法。
$array大批要搜索的数组。

返回值：

搜索到的值，否则为 null。

放

使用点表示法设置数组中的值。 

Arr:: set ( string $ key , mixed $ value , array & $ array ): boolean

数组集

相关的全局函数（说明见上文）。

（向后跳） 

 array_set ( string key, mixed value, array $ array ): boolean

实施例1 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_set ( ' baz.qux ' , ' bazqux ' , $ array );

// (
//     [foo] => bar
//     [baz] => [
//         [qux] => bazqux
//     ]
// )

实施例2 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_set ( ' baz.foo ' , ' bar ' , $ array );

// (
//     [foo] => bar
//     [baz] => [
//         [qux] => bazqux
//         [foo] => bar
//     ]
// )
  • 该方法是静态的。参数：
范围类型描述
$key细绳使用点符号设置的键。
$value混合的要在指定键上设置的值。
$array大批相关数组。

返回值：

如果新值设置成功，则为 true，否则为 false。

开发者

帮助程序类，与用户代理一起提供对有用的 php 函数的轻松访问。

类开发

  • 全名：CNZHelpersDev

是智能手机

确定当前设备是否是智能手机。 

Dev:: isSmartphone (  ): boolean

is_智能手机

相关的全局函数（说明见上文）。

（向后跳） 

 is_smartphone (  ): boolean

例子

 if ( is_smartphone () ) {
     // I am a smartphone
}
  • 该方法是静态的。

返回值：

如果当前访问者使用智能手机，则为 true，否则为 false。

是移动

检测当前访客是否使用移动设备（智能手机/平板电脑/手持设备）。 

Dev:: isMobile (  ): boolean

is_mobile

相关的全局函数（说明见上文）。

（向后跳） 

 is_mobile (  ): boolean

例子

 if ( is_mobile () ) {
     // I am a mobile device (smartphone/tablet or handheld)
}
  • 该方法是静态的。

返回值：

如果当前访问者使用移动设备，则为 true，否则为 false。

移动检测

获取一个单例 MobileDetect 对象来调用它提供的每个方法。 

Dev::mobileDetect(  ):  Detection  MobileDetect

可供此类外部使用的公共访问。 Mobile_Detect doku：https://github.com/serbanghita/Mobile-Detect

该方法没有相关的全局函数！

（向后跳）

例子

Dev:: mobileDetect ()-> version ( ' Android ' );

// 8.1
  • 该方法是静态的。

返回值：

一个单例 MobileDetect 对象，用于调用它提供的每个方法。

是平板电脑

确定当前访问者是否使用平板电脑设备。 

Dev:: isTablet (  ): boolean

是_平板电脑

相关的全局函数（说明见上文）。

（向后跳） 

 is_tablet (  ): boolean

例子

 if ( is_tablet () ) {
     // I am a tablet
}
  • 该方法是静态的。

返回值：

如果当前访问者使用平板电脑设备，则为 true，否则为 false。

是桌面

确定当前访问者是否使用台式计算机。 

Dev:: isDesktop (  ): boolean

是桌面

相关的全局函数（说明见上文）。

（向后跳） 

 is_desktop (  ): boolean

例子

 if ( is_desktop () ) {
     // I am a desktop computer (Mac, Linux, Windows)
}
  • 该方法是静态的。

返回值：

如果当前访问者使用台式计算机，则为 true，否则为 false。

是机器人

确定当前访问者是否是搜索引擎/机器人/爬虫/蜘蛛。 

Dev:: isRobot (  ): boolean

是机器人

相关的全局函数（说明见上文）。

（向后跳） 

 is_robot (  ): boolean

例子

 if ( is_robot () ) {
     // I am a robot (search engine, bot, crawler, spider)
}
  • 该方法是静态的。

返回值：

如果当前访问者是搜索引擎/机器人/爬虫/蜘蛛，则为 true，否则为 false。

爬虫检测

获取一个单例 CrawlerDetect 对象来调用它提供的每个方法。 

Dev::crawlerDetect(  ):  Jaybizzle  CrawlerDetect  CrawlerDetect

可供此类外部使用的公共访问。 Crawler-Detect doku：https://github.com/JayBizzle/Crawler-Detect

该方法没有相关的全局函数！

（向后跳）

例子

Dev:: crawlerDetect ()-> getMatches ();

// Output the name of the bot that matched (if any)
  • 该方法是静态的。

是Android

确定当前设备是否运行 Android 操作系统。 

Dev:: isAndroid (  ): boolean

是_android

相关的全局函数（说明见上文）。

（向后跳） 

 is_android (  ): boolean

例子

 if ( is_android () ) {
     // I am an Android based device
}
  • 该方法是静态的。

返回值：

如果当前访问者使用基于 Android 的设备，则为 true，否则为 false。

是iPhone

确定当前设备是否是 iPhone。 

Dev:: isIphone (  ): boolean

是_iphone

相关的全局函数（说明见上文）。

（向后跳） 

 is_iphone (  ): boolean

例子

 if ( is_iphone () ) {
     // I am an iPhone
}
  • 该方法是静态的。

返回值：

如果当前访问者使用 iPhone，则为 true，否则为 false。

是三星

确定当前设备是否来自三星。 

Dev:: isSamsung (  ): boolean

是_三星

相关的全局函数（说明见上文）。

（向后跳） 

 is_samsung (  ): boolean

例子

 if ( is_samsung () ) {
     // I am a device from Samsung
}
  • 该方法是静态的。

返回值：

如果当前访问者使用三星设备，则为 true，否则为 false。

IOS

确定当前设备是否运行 iOS 操作系统。 

Dev:: isIOS (  ): boolean

is_ios

相关的全局函数（说明见上文）。

（向后跳） 

 is_ios (  ): boolean

例子

 if ( is_ios () ) {
     // I am an iOS based device
}
  • 该方法是静态的。

返回值：

如果当前访问者使用 iOS 设备，则为 true，否则为 false。

斯特

帮助程序类，提供对有用的 php 字符串函数的轻松访问。

强度等级

  • 全名：CNZHelpersStr

插入

将一个或多个字符串插入到另一个字符串中的指定位置。 

Str:: insert ( array $ keyValue , string $ string ): string

字符串插入

相关的全局函数（说明见上文）。

（向后跳） 

 str_insert ( array $ keyValue , string $ string ): string

例子

 $ keyValue = [
     ' :color ' => ' brown ' ,
     ' :animal ' => ' dog '
]
$ string = ' The quick :color fox jumps over the lazy :animal. ' ;

str_insert ( $ keyValue , $ string );

// The quick brown fox jumps over the lazy dog.
  • 该方法是静态的。参数：
范围类型描述
$keyValue大批具有键 => 值对的关联数组。
$string细绳带有要替换的字符串的文本。

返回值：

替换后的字符串。

之间

返回左侧元素和右侧元素之间的字符串内容。 

Str:: between ( string $ left , string $ right , string $ string ): array

字符串之间

相关的全局函数（说明见上文）。

（向后跳） 

 str_between ( string $ left , string $ right , string $ string ): array

例子

 $ string = ' <tag>foo</tag>foobar<tag>bar</tag> '

str_between ( ' <tag> ' , ' </tag> ' $ string );

// (
//     [0] => foo
//     [1] => bar
// )
  • 该方法是静态的。参数：
范围类型描述
$left细绳要搜索的字符串的左侧元素。
$right细绳要搜索的字符串的右侧元素。
$string细绳要搜索的字符串。

返回值：

包含搜索的所有匹配项的结果数组。

后

返回给定值之后的字符串部分。 

Str:: after ( string $ search , string $ string ): string

字符串后

相关的全局函数（说明见上文）。

（向后跳） 

 str_after ( string $ search , string $ string ): string

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_after ( ' fox ' $ string );

// jumps over the lazy dog
  • 该方法是静态的。参数：
范围类型描述
$search细绳要搜索的字符串。
$string细绳要搜索的字符串。

返回值：

搜索字符串之后找到的字符串。开头的空格将被删除。

前

获取给定值之前的字符串部分。 

Str:: before ( string $ search , string $ string ): string

之前的str_

相关的全局函数（说明见上文）。

（向后跳） 

 str_before ( string $ search , string $ string ): string

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_before ( ' fox ' $ string );

// The quick brown
  • 该方法是静态的。参数：
范围类型描述
$search细绳要搜索的字符串。
$string细绳要搜索的字符串。

返回值：

搜索字符串之前找到的字符串。末尾的空格将被删除。

限制字数

限制字符串中的单词数。将 $end 的值放入字符串末尾。 

Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): string

字符串限制字数

相关的全局函数（说明见上文）。

（向后跳） 

 str_limit_words ( string $ string , int $ limit = 10 , string $ end = ' ... ' ): string

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_limit_words ( $ string , 3 );

// The quick brown...
  • 该方法是静态的。参数：
范围类型描述
$string细绳限制字数的字符串。
$limit整数限制字数。默认为 10。
$end细绳用于结束剪切字符串的字符串。默认为“...”

返回值：

末尾带有 $end 的有限字符串。

限制

限制字符串中的字符数。将 $end 的值放入字符串末尾。 

Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): string

字符串限制

相关的全局函数（说明见上文）。

（向后跳） 

 str_limit ( string $ string , int $ limit = 100 , string $ end = ' ... ' ): string

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_limit ( $ string , 15 );

// The quick brown...
  • 该方法是静态的。参数：
范围类型描述
$string细绳限制字符的字符串。
$limit整数要限制的字符数。默认为 100。
$end细绳用于结束剪切字符串的字符串。默认为“...”

返回值：

末尾带有 $end 的有限字符串。

包含

测试字符串是否包含给定元素

Str:: contains ( string|array $ needle , string $ haystack ): boolean

字符串包含

相关的全局函数（说明见上文）。

（向后跳） 

 str_contains ( string|array $ needle , string $ haystack ): boolean

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' cat ' ,
     ' fox '
];

str_contains ( $ array , $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$needle字符串|数组一个字符串或字符串数​​组。
$haystack细绳要搜索的字符串。

返回值：

如果找到 $needle，则为 true，否则为 false。

包含忽略大小写

测试字符串是否包含给定元素。忽略大小写。 

Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_icontains

相关的全局函数（说明见上文）。

（向后跳） 

 str_icontains ( string|array $ needle , string $ haystack ): boolean

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' Cat ' ,
     ' Fox '
];

str_icontains ( $ array , $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$needle字符串|数组一个字符串或字符串数​​组。
$haystack细绳要搜索的字符串。

返回值：

如果找到 $needle，则为 true，否则为 false。

开始于

确定给定字符串是否以给定子字符串开头。 

Str:: startsWith ( string|array $ needle , string $ haystack ): boolean

str_starts_with

相关的全局函数（说明见上文）。

（向后跳） 

 str_starts_with ( string|array $ needle , string $ haystack ): boolean

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' Cat ' ,
     ' The '
];

str_starts_with ( $ array , $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$needle字符串|数组要搜索的字符串或字符串数​​组。
$haystack细绳要搜索的字符串。

返回值：

如果找到 $needle，则为 true，否则为 false。

以忽略大小写开头

确定给定字符串是否以给定子字符串开头。忽略大小写。 

Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_istarts_with

相关的全局函数（说明见上文）。

（向后跳） 

 str_istarts_with ( string|array $ needle , string $ haystack ): boolean

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' cat ' ,
     ' the '
];

str_istarts_with ( $ array , $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$needle字符串|数组要搜索的字符串或字符串数​​组。
$haystack细绳要搜索的字符串。

返回值：

如果找到 $needle，则为 true，否则为 false。

结束于

确定给定字符串是否以给定子字符串结尾。 

Str:: endsWith ( string|array $ needle , string $ haystack ): boolean

str_ends_with

相关的全局函数（说明见上文）。

（向后跳） 

 str_ends_with ( string|array $ needle , string $ haystack ): boolean

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' cat ' ,
     ' dog '
];

str_ends_with ( $ array , $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$needle字符串|数组要搜索的字符串或字符串数​​组。
$haystack细绳要搜索的字符串。

返回值：

如果找到 $needle，则为 true，否则为 false。

以忽略大小写结尾

确定给定字符串是否以给定子字符串结尾。 

Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_iends_with

相关的全局函数（说明见上文）。

（向后跳） 

 str_iends_with ( string|array $ needle , string $ haystack ): boolean

例子

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' Cat ' ,
     ' Dog '
];

str_iends_with ( $ array , $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$needle字符串|数组要搜索的字符串或字符串数​​组。
$haystack细绳要搜索的字符串。

返回值：

如果找到 $needle，则为 true，否则为 false。

最后之后

返回最后一次出现给定搜索值之后的字符串部分。 

Str:: afterLast ( string $ search , string $ string ): string

str_after_last

相关的全局函数（说明见上文）。

（向后跳） 

 str_after_last ( string $ search , string $ string ): string

例子

 $ path = " /var/www/html/public/img/image.jpg " ;

str_after_last ( ' / ' $ path );

// image.jpg
  • 该方法是静态的。参数：
范围类型描述
$search细绳要搜索的字符串。
$string细绳要搜索的字符串。

返回值：

搜索字符串最后一次出现后找到的字符串。开头的空格将被删除。

效用

帮助程序类，提供对有用的常见 php 函数的轻松访问。

类实用程序

  • 全名：CNZHelpersUtil

是电子邮件

验证给定的电子邮件地址。 

Util:: isEmail ( string $ email ): boolean

是_电子邮件

相关的全局函数（说明见上文）。

（向后跳） 

 is_email ( string $ email ): boolean

例子

 $ email = ' [email protected] ' ;

is_email ( $ email );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$email细绳要测试的电子邮件地址。

返回值：

如果给定字符串是有效的电子邮件地址，则为 true，否则为 false。

ip

获取用户当前的ip地址。 

Util:: ip (  ): string| null

用户ip

相关的全局函数（说明见上文）。

（向后跳） 

 ip (  ): null|string

例子

 echo ip ();

// 127.0.0.1
  • 该方法是静态的。

返回值：

检测到的ip地址，如果没有检测到ip则为空。

加密密码

根据给定密码创建安全哈希。使用 CRYPT_BLOWFISH 算法。 

Util:: cryptPassword ( string $ password ): string

注意：建议数据库列长度为 255 个字符！

密码密码

相关的全局函数（说明见上文）。

（向后跳） 

 crypt_password ( string $ password ): string

例子

 $ password = ' foobar ' ;

crypt_password ( $ password );

// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC
  • 该方法是静态的。参数：
范围类型描述
$password细绳要加密的密码。

返回值：

加密的密码。

是密码

验证密码是否与加密密码匹配（CRYPT_BLOWFISH 算法）。 

Util:: isPassword ( string $ password , string $ cryptedPassword ): boolean

是_密码

相关的全局函数（说明见上文）。

（向后跳） 

 is_password ( string $ password , string $ cryptedPassword ): boolean

例子

 $ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;

is_password ( $ password , $ cryptedPassword );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$password细绳要测试的密码。
$cryptedPassword细绳加密的密码（例如存储在数据库中）。

DD

转储给定变量的内容并退出脚本。 

Util:: dd ( mixed $ var )

DD

相关的全局函数（说明见上文）。

（向后跳） 

 dd ( mixed $ var )

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

dd ( $ array );

// (
//     [foo] => bar
//     [baz] => qux
// )
  • 该方法是静态的。参数：
范围类型描述
$var混合的要转储的变量。

倾倒

转储给定变量的内容。调用后脚本不会停止。 

Util:: dump ( mixed $ var )

倾倒

相关的全局函数（说明见上文）。

（向后跳） 

 dump ( mixed $ var )

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

dump ( $ array );

// (
//     [foo] => bar
//     [baz] => qux
// )
  • 该方法是静态的。参数：
范围类型描述
$var混合的要转储的变量。

yml

帮助程序类，提供对有用的 php yml 函数的轻松访问。

Yml级

  • 全名：CNZHelpersYml

有效文件

验证给定文件是否包含 yaml 语法。 

Yml:: isValidFile ( string $ file ): boolean

is_yml_文件

相关的全局函数（说明见上文）。

（跳回来） 

 is_yml_file ( string $ file ): boolean

例子

 $ file = /path/to/file.yml

is_yml_file ( $ file );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$file细绳用于测试 yaml 语法的文件。

返回值：

如果文件包含 yaml 语法，则为 true，否则为 false。

有效

测试给定字符串的语法是否为 yaml。 

Yml:: isValid ( string $ string ): boolean

is_yml

相关的全局函数（说明见上文）。

（向后跳） 

 is_yml ( string $ string ): boolean

例子

 $ string = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

is_yml ( $ string );

// bool(true)
  • 该方法是静态的。参数：
范围类型描述
$string细绳用于测试 yaml 语法的字符串。

返回值：

如果字符串是 yaml，则为 true，否则为 false。

解析

将给定的 yaml 字符串转换为数组。 

Yml:: parse ( string $ yml ): array| null

yml_解析

相关的全局函数（说明见上文）。

（向后跳） 

 yml_parse ( string $ yml ): array| null

例子

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_parse ( $ yml );

// (
//       [foo] => bar
//       [baz] => qux
//       [foobar] => (
//           [foo] => bar
//       )
// )
  • 该方法是静态的。参数：
范围类型描述
$yml细绳要解析的 yaml 字符串。

返回值：

转换后的数组，错误时为 null。

得到

使用点表示法获取 yaml 字符串中的值。 

Yml:: get ( string $ key , string $ yml ): mixed

yml_get

相关的全局函数（说明见上文）。

（向后跳） 

 yml_get ( string $ key , string $ yml ): mixed

例子

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_get ( ' foobar.foo ' , $ yml );

// bar
  • 该方法是静态的。参数：
范围类型描述
$key细绳使用点符号进行搜索的键（例如“foo.bar.baz”）。
$yml细绳要搜索的 yml 字符串。

返回值：

找到的值，否则为 null。

获取文件

使用点表示法获取 yaml 文件中的值。 

Yml:: getFile ( string $ key , string $ ymlfile ): mixed

yml_get_file

相关的全局函数（说明见上文）。

（向后跳） 

 yml_get_file ( string $ key , string $ ymlfile ): mixed

例子

 $ ymlfile = ' /path/to/file.yml ' ;

yml_get_file ( ' foobar.foo ' , $ ymlfile );

// bar
  • 该方法是静态的。参数：
范围类型描述
$key细绳使用点符号进行搜索的键（例如“foo.bar.baz”）。
$ymlfile细绳要搜索的 yml 文件。

返回值：

找到的值，否则为 null。

解析文件

将 yamlfile 的内容加载到数组中。 

Yml:: parseFile ( string $ ymlfile ): array

yml_解析文件

相关的全局函数（说明见上文）。

（向后跳） 

 yml_parse_file ( string $ ymlfile ): array| null

例子

 $ ymlfile = ' /path/to/file.yml ' ;

yml_parse_file ( $ ymlfile );

// (
//       [foo] => bar
//       [baz] => qux
//       [foobar] => (
//           [foo] => bar
//       )
// )
  • 该方法是静态的。参数：
范围类型描述
$ymlfile细绳要读取的文件的路径。

返回值：

解析后的数组。

设置文件

使用点符号在 yamlfile 中设置值。注意：文件中的所有评论都将被删除！ 

Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): boolean

yml_set_file

相关的全局函数（说明见上文）。

（向后跳） 

 yml_set_file ( string $ key , mixed $ value , string $ ymlfile ): boolean

例子

 $ ymlfile = ' /path/to/file.yml ' ;

yml_set_file ( ' foobar.foo ' , ' baz ' , $ ymlfile );

//   foo: bar
//   baz: qux
//   foobar:
//       foo: baz
  • 该方法是静态的。参数：
范围类型描述
$key细绳使用点符号搜索的字符串
$value混合的要在指定键上设置的值。
$ymlfile细绳要在其中设置值的 yml 文件。

返回值：

如果在 yamlfile 中成功设置值，则为 True，否则为 false。

转储文件

将给定数组转换为 yaml 语法并将其内容放入给定文件中。注意：如果文件存在，则会被覆盖！ 

Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean

到_yml_文件

相关的全局函数（说明见上文）。

（向后跳） 

 to_yml_file ( array|object $ var , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): boolean

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

to_yml_file ( $ array , ' /path/to/file.yml ' );

//   foo: bar
//   baz: qux
  • 该方法是静态的。参数：
范围类型描述
$var数组|对象要转换的数组或对象。
$filename细绳要写入 yaml 字符串的文件的路径。注意：如果文件已经存在，则会被覆盖！
$indent整数转换后的 yaml 的缩进。默认为 2。
$wordwrap整数在给定数字之后，将换行一个字符串。默认为 0（无自动换行）。
$openingDashes布尔值如果 yaml 字符串应以破折号开头，则为 true。默认为 false。

返回值：

成功时为真，否则为假。

倾倒

将给定数组或对象转换为 yaml 字符串。 

Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null

to_yml

相关的全局函数（说明见上文）。

（向后跳） 

 to_yml ( array|object $ array , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): string| null

例子

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux ' ,
     ' foobar ' => [
         ' foo ' => ' bar '
     ]
];

to_yml ( $ array );

//   foo: bar
//   baz: qux
//   foobar:
//     foo: bar
  • 该方法是静态的。参数：
范围类型描述
$var数组|对象要转换的数组或对象。
$indent整数转换后的 yaml 的缩进。默认为 2。
$wordwrap整数在给定数字之后，将换行一个字符串。默认为 0（无自动换行）。
$openingDashes布尔值如果 yaml 字符串应以破折号开头，则为 True。默认为 false。

返回值：

转换后的 yaml 字符串。如果出现错误，则返回 null。

放

使用点表示法在 yaml 字符串中设置值。 

Yml:: set ( string $ key , mixed $ value , string & $ yml ): boolean

yml_set

相关的全局函数（说明见上文）。

（向后跳） 

 yml_set ( string $ key , mixed $ value , string & $ yml ): boolean

例子

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_set ( ' foobar.foo ' , ' baz ' , $ yml );

//   foo: bar
//   baz: qux
//   foobar:
//       foo: baz
  • 该方法是静态的。参数：
范围类型描述
$key细绳使用点符号搜索的字符串
$value混合的要在指定键上设置的值。
$yml细绳要搜索的 yml 字符串。注意：字符串中的所有注释都将被删除！

返回值：

如果值设置成功则为 true，否则为 false。

本文档是使用 phpDocumentor 和 cvuorinen/phpdoc-markdown-public 根据 2018-01-22 的源代码注释自动生成的

展开
附加信息
相关应用
为您推荐
相关资讯 全部