首頁>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 年 1 月 22 日根據原始碼註解自動產生的

展開
附加信息
相關應用
爲您推薦
相關資訊 全部