php helpers
33
ライブラリ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 ' );このライブラリは、次の優れたよく知られたライブラリを利用します。
すべての関数は、多数の単体テストと PHP バージョンに対してテストされます。
最新のclausnz/php-helperライブラリをcomposerとともにインストールします。
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 配列関数への簡単なアクセスを提供するヘルパー クラス。
クラス到着
指定された値が連想配列かどうかを検出します。
Arr:: isAssoc ( array $ array ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
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 $ var = ' php ' ;
to_array ( $ var );
// (
// [0] => p
// [1] => h
// [2] => p
// ) $ 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 $ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_set ( ' baz.qux ' , ' bazqux ' , $ array );
// (
// [foo] => bar
// [baz] => [
// [qux] => bazqux
// ]
// ) $ 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 関数に簡単にアクセスできるようにするヘルパー クラス。
クラス開発
現在のデバイスがスマートフォンかどうかを判断します。
Dev:: isSmartphone ( ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_smartphone ( ): boolean if ( is_smartphone () ) {
// I am a smartphone
}戻り値:
現在の訪問者がスマートフォンを使用している場合は true、それ以外の場合は false。
現在の訪問者がモバイル デバイス (スマートフォン/タブレット/ハンドヘルド) を使用しているかどうかを検出します。
Dev:: isMobile ( ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_mobile ( ): boolean if ( is_mobile () ) {
// I am a mobile device (smartphone/tablet or handheld)
}戻り値:
現在の訪問者がモバイル デバイスを使用している場合は true、それ以外の場合は false。
シングルトンの MobileDetect オブジェクトを取得して、それが提供するすべてのメソッドを呼び出します。
Dev::mobileDetect( ): Detection MobileDetectこのクラス外で使用するためのパブリック アクセス。 Mobile_Detect ドキュメント: 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 ドキュメント: https://github.com/JayBizzle/Crawler-Detect
このメソッドには関連するグローバル関数がありません。
(ジャンプバック)
Dev:: crawlerDetect ()-> getMatches ();
// Output the name of the bot that matched (if any)現在のデバイスが Android オペレーティング システムを実行しているかどうかを判断します。
Dev:: isAndroid ( ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_android ( ): boolean if ( is_android () ) {
// I am an Android based device
}戻り値:
現在の訪問者が Android ベースのデバイスを使用している場合は true、それ以外の場合は false。
現在のデバイスが iPhone であるかどうかを判断します。
Dev:: isIphone ( ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_iphone ( ): boolean if ( is_iphone () ) {
// I am an iPhone
}戻り値:
現在の訪問者が iPhone を使用している場合は true、それ以外の場合は false。
現在のデバイスが Samsung 製かどうかを判断します。
Dev:: isSamsung ( ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_samsung ( ): boolean if ( is_samsung () ) {
// I am a device from Samsung
}戻り値:
現在の訪問者が Samsung デバイスを使用している場合は true、それ以外の場合は false。
現在のデバイスが iOS オペレーティング システムを実行しているかどうかを判断します。
Dev:: isIOS ( ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_ios ( ): boolean if ( is_ios () ) {
// I am an iOS based device
}戻り値:
現在の訪問者が iOS デバイスを使用している場合は true、それ以外の場合は false。
便利な PHP 文字列関数への簡単なアクセスを提供するヘルパー クラス。
クラスStr
1 つ以上の文字列を、定義された位置の別の文字列に挿入します。
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_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 ( 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 ( 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 ( 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 ( 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 ( 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 ( string $ search , string $ string ): string $ path = " /var/www/html/public/img/image.jpg " ;
str_after_last ( ' / ' $ path );
// image.jpg| パラメータ | タイプ | 説明 |
|---|---|---|
$search | 弦 | 検索する文字列。 |
$string | 弦 | 検索する文字列。 |
戻り値:
検索文字列が最後に出現した後に見つかった文字列。先頭の空白は削除されます。
便利な一般的な PHP 関数への簡単なアクセスを提供するヘルパー クラス。
クラス使用率
指定された電子メール アドレスを検証します。
Util:: isEmail ( string $ email ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
is_email ( string $ email ): boolean $ email = ' [email protected] ' ;
is_email ( $ email );
// bool(true)| パラメータ | タイプ | 説明 |
|---|---|---|
$email | 弦 | テストする電子メール アドレス。 |
戻り値:
指定された文字列が有効な電子メール アドレスの場合は true、それ以外の場合は false。
ユーザーの現在の IP アドレスを取得します。
Util:: ip ( ): string| null関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
ip ( ): null|string echo ip ();
// 127.0.0.1戻り値:
検出された IP アドレス。IP が検出されなかった場合は null。
指定されたパスワードから安全なハッシュを作成します。 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 | 弦 | 暗号化されたパスワード (データベースに保存されているなど)。 |
指定された変数の内容をダンプし、スクリプトを終了します。
Util:: dd ( mixed $ var )関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
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 | 混合された | ダンプする変数。 |
便利な php yml 関数への簡単なアクセスを提供するヘルパー クラス。
クラスYml
指定されたファイルに yaml 構文が含まれているかどうかを検証します。
Yml:: isValidFile ( string $ file ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
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 ( 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_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 ( 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 ( 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_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 ( 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 | 弦 | 値を設定する ymlfile。 |
戻り値:
値が yamlfile に正常に設定された場合は true、それ以外の場合は false。
指定された配列を yaml 構文に変換し、その内容を指定されたファイルに配置します。注: ファイルが存在する場合は上書きされます。
Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
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 です。 |
戻り値:
成功した場合は true、それ以外の場合は false。
指定された配列またはオブジェクトを yaml 文字列に変換します。
Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null関連するグローバル関数 (説明は上記を参照)。
(ジャンプバック)
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 ( 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 日にソース コード コメントから自動的に生成されました。
