Lodash-PHP は、Lodash JS ライブラリを PHP に移植したものです。これは、日常的な PHP プロジェクトで使用できる使いやすいユーティリティ関数のセットです。
Lodash-PHP は、lodash.js をできるだけ模倣しようとします。
Lodash-PHP には少なくとも PHP 7.2 以降が必要ですが、最新バージョンの PHP を常に推奨します。
Composer を通じて Lodash-PHP をインストールします。
$ composer require lodash-php/lodash-php
Lodash-PHP の各メソッドは、インポートして単独で使用できる個別の関数です。
<?php
use function _ each ;
each ([ 1 , 2 , 3 ], function ( int $ item ) {
var_dump ( $ item );
});
Lodash-PHP には、グローバルに使用できる global _
クラスも付属しています。
<?php
_:: each ([ 1 , 2 , 3 ], function ( int $ item ) {
var_dump ( $ item );
});
size
の長さのグループに分割された要素の配列を作成します。 array
均等に分割できない場合、最後のチャンクは残りの要素になります。
引数:
@param array $array array 処理する配列。
@param int $number [size=1] 各チャンクの長さ
戻る:
@return array チャンクの新しい配列を返します。
例:
<?php
use function _ chunk ;
chunk ([ ' a ' , ' b ' , ' c ' , ' d ' ], 2 )
// => [['a', 'b'], ['c', 'd']]
chunk ([ ' a ' , ' b ' , ' c ' , ' d ' ], 3 )
// => [['a', 'b', 'c'], ['d']]
すべての誤った値を削除した配列を作成します。値false
、 null
、 0
、 ""
、 undefined
、およびNaN
は falsey です。
引数:
@param array $array 圧縮する配列。
戻る:
@return array フィルタリングされた値の新しい配列を返します。
例:
<?php
use function _ compact ;
compact ([ 0 , 1 , false , 2 , '' , 3 ])
// => [1, 2, 3]
追加の配列および/または値を含むarray
を連結する新しい配列を作成します。
引数:
@param array $array 連結する配列。
@param array<int,mixed> $values 連結する値。
戻る:
@return array 新しい連結された配列を返します。
例:
<?php
use function _ concat ;
$ array = [ 1 ];
$ other = concat ( $ array , 2 , [ 3 ], [[ 4 ]]);
var_dump ( $ other )
// => [1, 2, 3, [4]]
var_dump ( $ array )
// => [1]
等価比較にSameValueZero
使用して、他の指定された配列に含まれないarray
値の配列を作成します。結果値の順序と参照は、最初の配列によって決まります。
注: pullAll
とは異なり、このメソッドは新しい配列を返します。
引数:
@param array $array 検査する配列。
@param array ...$values 除外する値。
戻る:
@return array フィルタリングされた値の新しい配列を返します。
例:
<?php
use function _ difference ;
difference ([ 2 , 1 ], [ 2 , 3 ])
// => [1]
このメソッドは、 array
とvalues
の各要素に対して呼び出され、それらを比較する基準を生成するiteratee
を受け入れる点を除けば、 difference
と似ています。結果値の順序と参照は、最初の配列によって決まります。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
注: pullAllBy
とは異なり、このメソッドは新しい配列を返します。
引数:
@param array $array 検査する配列。
@param array<int,mixed> ...$values 除外する値。
@param callable $iteratee 要素ごとに呼び出される iteratee。
戻る:
@return array フィルタリングされた値の新しい配列を返します。
例:
<?php
use function _ differenceBy ;
differenceBy ([ 2.1 , 1.2 ], [ 2.3 , 3.4 ], ' floor ' )
// => [1.2]
このメソッドは、 array
の要素をvalues
と比較するために呼び出されるcomparator
を受け入れる点を除いて、 difference
と似ています。結果値の順序と参照は、最初の配列によって決まります。コンパレータは 2 つの引数 (arrVal、othVal) を使用して呼び出されます。
注: pullAllWith
とは異なり、このメソッドは新しい配列を返します。
引数:
@param array<int,mixed> $array 検査する配列。
@param array ...$values 除外する値。
@param callable $comparator 要素ごとに呼び出されるコンパレータ。
戻る:
@return array フィルタリングされた値の新しい配列を返します。
例:
<?php
use function _ differenceWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ]]
differenceWith ( $ objects , [[ ' x ' => 1 , ' y ' => 2 ]], ' _::isEqual ' )
// => [[ 'x' => 2, 'y' => 1 ]]
n
要素を先頭から削除したarray
のスライスを作成します。
注:この関数は配列インデックスを並べ替えてリセットします。
引数:
@param array $array クエリする配列。
@param int $n 削除する要素の数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ drop ;
drop ([ 1 , 2 , 3 ])
// => [2, 3]
drop ([ 1 , 2 , 3 ], 2 )
// => [3]
drop ([ 1 , 2 , 3 ], 5 )
// => []
drop ([ 1 , 2 , 3 ], 0 )
// => [1, 2, 3]
n
要素を末尾から削除したarray
のスライスを作成します。注:この関数は配列インデックスを並べ替えてリセットします。
引数:
@param array $array クエリする配列。
@param int $n 削除する要素の数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ dropRight ;
dropRight ([ 1 , 2 , 3 ])
// => [1, 2]
dropRight ([ 1 , 2 , 3 ], 2 )
// => [1]
dropRight ([ 1 , 2 , 3 ], 5 )
// => []
dropRight ([ 1 , 2 , 3 ], 0 )
// => [1, 2, 3]
末尾から削除された要素を除いたarray
のスライスを作成します。 predicate
falsey を返すまで、要素は削除されます。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
引数:
@param array $array クエリする配列。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ dropRightWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => false ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => true ]
]
dropRightWhile ( $ users , function ( $ user ) { return $ user [ ' active ' ]; })
// => objects for ['barney']
先頭から削除された要素を除いたarray
のスライスを作成します。 predicate
falsey を返すまで、要素は削除されます。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
引数:
@param array $array クエリする配列。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ dropWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => false ]
]
dropWhile ( $ users , function ( $ user ) { return $ user [ ' active ' ]; } )
// => objects for ['pebbles']
predicate
array
のすべての要素に対して true を返すかどうかを確認します。 predicate
falsey を返すと反復が停止されます。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
注:空の配列の要素についてはすべてが true であるため、このメソッドは空の配列に対してtrue
を返します。
引数:
@param iterable $collection 反復する配列。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return bool すべての要素が述語チェックに合格した場合はtrue
、それ以外の場合はfalse
。
例:
<?php
use function _ every ;
every ([ true , 1 , null , ' yes ' ], function ( $ value ) { return is_bool ( $ value );})
// => false
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => false ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => false ],
];
// The `matches` iteratee shorthand.
$ this -> assertFalse ( every ( $ users , [ ' user ' => ' barney ' , ' active ' => false ]));
// false
// The `matchesProperty` iteratee shorthand.
$ this -> assertTrue ( every ( $ users , [ ' active ' , false ]));
// true
// The `property` iteratee shorthand.
$ this -> assertFalse ( every ( $ users , ' active ' ));
//false
このメソッドはfind
と似ていますが、要素自体ではなく最初の要素のインデックスを返す述語が true を返します。
引数:
@param array $array 検査する配列。
@param callable $predicate 反復ごとに呼び出される関数。
@param int $fromIndex 検索元のインデックス。
戻る:
@return int は見つかった要素のインデックス、それ以外の場合は-1
。
例:
<?php
use function _ findIndex ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => false ],
[ ' user ' => ' fred ' , ' active ' => false ],
[ ' user ' => ' pebbles ' , ' active ' => true ],
];
findIndex ( $ users , function ( $ o ) { return $ o [ ' user ' ] s== ' barney ' ; });
// => 0
// The `matches` iteratee shorthand.
findIndex ( $ users , [ ' user ' => ' fred ' , ' active ' => false ]);
// => 1
// The `matchesProperty` iteratee shorthand.
findIndex ( $ users , [ ' active ' , false ]);
// => 0
// The `property` iteratee shorthand.
findIndex ( $ users , ' active ' );
// => 2
このメソッドは、 collection
の要素を右から左に反復処理することを除いて、 findIndex
に似ています。
引数:
@param array $array 検査する配列。
@parammixed $predicate 反復ごとに呼び出される関数。
@param int $fromIndex 検索元のインデックス。
戻る:
@return int は見つかった要素のインデックス、それ以外の場合は-1
。
例:
<?php
use function _ findLastIndex ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => false ],
[ ' user ' => ' pebbles ' , ' active ' => false ]
]
findLastIndex ( $ users , function ( $ user ) { return $ user [ ' user ' ] === ' pebbles ' ; })
// => 2
array
1 レベルの深さに平坦化します。
引数:
@param array $array フラット化する配列。
戻る:
@return array 新しいフラット化された配列。
例:
<?php
use function _ flatten ;
flatten ([ 1 , [ 2 , [ 3 , [ 4 ]], 5 ]])
// => [1, 2, [3, [4]], 5]
再帰的にarray
を平坦化します。
引数:
@param array $array フラット化する配列。
戻る:
@return array 新しいフラット化された配列を返します。
例:
<?php
use function _ flattenDeep ;
flattenDeep ([ 1 , [ 2 , [ 3 , [ 4 ]], 5 ]]);
// => [1, 2, 3, 4, 5]
depth
時間までarray
再帰的に平坦化します。
引数:
@param array $array フラット化する配列。
@param int $ Depth 再帰の最大の深さ。
戻る:
@return array 新しいフラット化された配列。
例:
<?php
use function _ flattenDepth ;
$ array = [ 1 , [ 2 , [ 3 , [ 4 ]], 5 ]]
flattenDepth ( $ array , 1 )
// => [1, 2, [3, [4]], 5]
flattenDepth ( $ array , 2 )
// => [1, 2, 3, [4], 5]
toPairs
の逆のこのメソッドは、キーと値のpairs
から構成されるオブジェクトを返します。
引数:
@param array $pairs キーと値のペア。
戻る:
@return stdClass 新しいオブジェクト。
例:
<?php
use function _ fromPairs ;
fromPairs ([[ ' a ' , 1 ], [ ' b ' , 2 ]])
// => stdClass(
// 'a' => 1,
//'b' => 2,
// )
array
の最初の要素を取得します。
引数:
@param array $array クエリする配列。
戻る:
@returnmixed array
の最初の要素を返します。
例:
<?php
use function _ head ;
head ([ 1 , 2 , 3 ])
// => 1
head ([])
// => null
等価比較にSameValueZero
を使用して、 array
内でvalue
が最初に見つかったインデックスを取得します。 fromIndex
が負の場合、 array
の末尾からのオフセットとして使用されます。
引数:
@param array $array 検査する配列。
@parammixed $value 検索する値。
@param int $fromIndex 検索元のインデックス。
戻る:
@return int 一致した値のインデックス、それ以外の場合は-1
。
例:
<?php
use function _ indexOf ;
indexOf ([ 1 , 2 , 1 , 2 ], 2 )
// => 1
// Search from the `fromIndex`.
indexOf ([ 1 , 2 , 1 , 2 ], 2 , 2 )
// => 3
array
の最後の要素を除くすべての要素を取得します。
引数:
@param array $array クエリする配列。
戻る:
@return array array
のスライス。
例:
<?php
use function _ initial ;
initial ([ 1 , 2 , 3 ])
// => [1, 2]
等価比較にSameValueZero
を使用して、指定されたすべての配列に含まれる一意の値の配列を作成します。結果値の順序と参照は、最初の配列によって決まります。
引数:
@param 配列 ...$arrays
戻る:
@return array 交差する値の新しい配列。
例:
<?php
use function _ intersection ;
intersection ([ 2 , 1 ], [ 2 , 3 ])
// => [2]
このメソッドは、各arrays
の要素ごとに呼び出されて比較基準を生成するiteratee
を受け入れる点を除けば、 intersection
に似ています。結果値の順序と参照は、最初の配列によって決まります。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param array<int,mixed> ...$arrays
@param callable $iteratee 要素ごとに呼び出される iteratee。
戻る:
@return array 交差する値の新しい配列。
例:
<?php
use function _ intersectionBy ;
intersectionBy ([ 2.1 , 1.2 ], [ 2.3 , 3.4 ], Math.floor)
// => [2.1]
// The `property` iteratee shorthand.
intersectionBy ([[ ' x ' => 1 ]], [[ ' x ' => 2 ], [ ' x ' => 1 ]], ' x ' );
// => [[ 'x' => 1 ]]
このメソッドは、 arrays
の要素を比較するために呼び出されるcomparator
を受け入れることを除いて、 intersection
と似ています。結果値の順序と参照は、最初の配列によって決まります。コンパレータは 2 つの引数 (arrVal、othVal) を使用して呼び出されます。
引数:
@param 配列 ...$arrays
@param callable $comparator 要素ごとに呼び出されるコンパレータ。
戻る:
@return array 交差する値の新しい配列。
例:
<?php
use function _ intersectionWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ]]
$ others = [[ ' x ' => 1 , ' y ' => 1 ], [ ' x ' => 1 , ' y ' => 2 ]]
intersectionWith ( $ objects , $ others , ' _::isEqual ' )
// => [[ 'x' => 1, 'y' => 2 ]]
array
の最後の要素を取得します。
引数:
@param array $array クエリする配列。
戻る:
@returnmixed array
の最後の要素を返します。
例:
<?php
use function _ last ;
last ([ 1 , 2 , 3 ])
// => 3
このメソッドは、 array
の要素を右から左に反復処理する点を除けば、 indexOf
に似ています。
引数:
@param array $array 検査する配列。
@parammixed $value 検索する値。
@param int $fromIndex 検索元のインデックス。
戻る:
@return int 一致した値のインデックス、それ以外の場合は-1
。
例:
<?php
use function _ lastIndexOf ;
lastIndexOf ([ 1 , 2 , 1 , 2 ], 2 )
// => 3
// Search from the `fromIndex`.
lastIndexOf ([ 1 , 2 , 1 , 2 ], 2 , 2 )
// => 1
array
のインデックスn
にある要素を取得します。 n
が負の場合、最後から n 番目の要素が返されます。
引数:
@param array $array クエリする配列。
@param int $n 返す要素のインデックス。
戻る:
@returnmixed array
の n 番目の要素を返します。
例:
<?php
use function _ nth ;
$ array = [ ' a ' , ' b ' , ' c ' , ' d ' ]
nth ( $ array , 1 )
// => 'b'
nth ( $ array , - 2 )
// => 'c'
等価比較にSameValueZero
を使用して、指定されたすべての値をarray
から削除します。
注: without
異なり、このメソッドはarray
変更します。述語によって配列から要素を削除するには、 remove
使用します。
引数:
@param array $array 変更する配列。
@param array<int, string> $values 削除する値。
戻る:
@return 配列
例:
<?php
use function _ pull ;
$ array = [ ' a ' , ' b ' , ' c ' , ' a ' , ' b ' , ' c ' ]
pull ( $ array , ' a ' , ' c ' )
var_dump ( $ array )
// => ['b', 'b']
このメソッドは、削除する値の配列を受け入れる点を除けばpull
と似ています。
注: difference
とは異なり、このメソッドはarray
変更します。
引数:
@param array $array 変更する配列。
@param array $values 削除する値。
戻る:
@return array
array 。
例:
<?php
use function _ pullAll ;
$ array = [ ' a ' , ' b ' , ' c ' , ' a ' , ' b ' , ' c ' ]
pullAll ( $ array , [ ' a ' , ' c ' ])
var_dump ( $ array )
// => ['b', 'b']
このメソッドはpullAll
に似ていますが、 array
とvalues
の各要素に対して呼び出されて比較基準を生成するiteratee
を受け入れる点が異なります。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
注: differenceBy
とは異なり、このメソッドはarray
変更します。
引数:
@param array $array 変更する配列。
@param array $values 削除する値。
@param callable $iteratee 要素ごとに呼び出される iteratee。
戻る:
@return array
array 。
例:
<?php
use function _ pullAllBy ;
$ array = [[ ' x ' => 1 ], [ ' x ' => 2 ], [ ' x ' => 3 ], [ ' x ' => 1 ]]
pullAllBy ( $ array , [[ ' x ' => 1 ], [ ' x ' => 3 ]], ' x ' )
var_dump ( $ array )
// => [[ 'x' => 2 ]]
このメソッドは、 array
の要素をvalues
と比較するために呼び出されるcomparator
を受け入れる点を除いて、 pullAll
に似ています。コンパレータは 2 つの引数 (arrVal、othVal) を使用して呼び出されます。
注: differenceWith
とは異なり、このメソッドはarray
変更します。
引数:
@param array $array 変更する配列。
@param array $values 削除する値。
@param callable $comparator 要素ごとに呼び出されるコンパレータ。
戻る:
@return array
array 。
例:
<?php
use function _ pullAllWith ;
$ array = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 3 , ' y ' => 4 ], [ ' x ' => 5 , ' y ' => 6 ]]
pullAllWith ( $ array , [[ ' x ' => 3 , ' y ' => 4 ]], ' _isEqual ' )
var_dump ( $ array )
// => [[ 'x' => 1, 'y' => 2 ], [ 'x' => 5, 'y' => 6 ]]
indexes
に対応するarray
から要素を削除し、削除された要素の配列を返します。
注: at
は異なり、このメソッドはarray
変更します。
引数:
@param array $array 変更する配列。
@param (int | int[]) $indexes 削除する要素のインデックス。
戻る:
@return array 削除された要素の新しい配列。
例:
<?php
use function _ pullAt ;
$ array = [ ' a ' , ' b ' , ' c ' , ' d ' ]
$ pulled = pullAt ( $ array , [ 1 , 3 ])
var_dump ( $ array )
// => ['a', 'c']
var_dump ( $ pulled )
// => ['b', 'd']
predicate
true を返すarray
からすべての要素を削除し、削除された要素の配列を返します。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
注: filter
とは異なり、このメソッドはarray
変更します。 pull
使用して、値によって配列から要素をプルします。
引数:
@param array $array 変更する配列。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array 削除された要素の新しい配列。
例:
<?php
use function _ remove ;
$ array = [ 1 , 2 , 3 , 4 ]
$ evens = remove ( $ array , function ( $ n ) { return $ n % 2 === 0 ; })
var_dump ( $ array )
// => [1, 3]
var_dump ( $ evens )
// => [2, 4]
array
からランダムな要素を取得します。
引数:
@param array $array サンプリングする配列。
戻る:
@returnmixed ランダムな要素を返します。
例:
<?php
use function _ sample ;
sample ([ 1 , 2 , 3 , 4 ])
// => 2
array
のサイズまでの一意のarray
にあるn
個のランダムな要素を取得します。
引数:
@param array $array サンプリングする配列。
@param int $n サンプリングする要素の数。
戻る:
@return ランダムな要素を配列します。
例:
<?php
use function _ sampleSize ;
sampleSize ([ 1 , 2 , 3 ], 2 )
// => [3, 1]
sampleSize ([ 1 , 2 , 3 ], 4 )
// => [2, 3, 1]
シャッフルされた値の配列を作成します
引数:
@param array $array シャッフルする配列。
戻る:
@return array 新しいシャッフルされた配列。
例:
<?php
use function _ shuffle ;
shuffle ([ 1 , 2 , 3 , 4 ])
// => [4, 1, 3, 2]
start
から end までのarray
のスライスを作成します ( end
は含みません)。
引数:
@param array $array スライスする配列。
@param int $start 開始位置。
@param int $end 終了位置。
戻る:
@return array array
のスライス。
array
の最初の要素を除くすべてを取得します。
引数:
@param array $array クエリする配列。
戻る:
@return array array
のスライス。
例:
<?php
use function _ tail ;
tail ([ 1 , 2 , 3 ])
// => [2, 3]
先頭からn
個の要素を取得したarray
のスライスを作成します。
引数:
@param array $array クエリする配列。
@param int $n 取得する要素の数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ take ;
take ([ 1 , 2 , 3 ])
// => [1]
take ([ 1 , 2 , 3 ], 2 )
// => [1, 2]
take ([ 1 , 2 , 3 ], 5 )
// => [1, 2, 3]
take ([ 1 , 2 , 3 ], 0 )
// => []
末尾からn
個の要素を取り出したarray
のスライスを作成します。
引数:
@param array $array クエリする配列。
@param int $n 取得する要素の数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ takeRight ;
takeRight ([ 1 , 2 , 3 ])
// => [3]
takeRight ([ 1 , 2 , 3 ], 2 )
// => [2, 3]
takeRight ([ 1 , 2 , 3 ], 5 )
// => [1, 2, 3]
takeRight ([ 1 , 2 , 3 ], 0 )
// => []
末尾から要素を取り出したarray
のスライスを作成します。要素は、 predicate
falsey を返すまで取得されます。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
引数:
@param array $array クエリする配列。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ takeRightWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => false ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => true ]
];
takeRightWhile ( $ users , function ( $ value ) { return $ value [ ' active ' ]; })
// => objects for ['fred', 'pebbles']
先頭から取得した要素を含むarray
のスライスを作成します。要素は、 predicate
falsey を返すまで取得されます。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
引数:
@param array $array クエリする配列。
@parammixed $predicate 反復ごとに呼び出される関数。
戻る:
@return array array
のスライス。
例:
<?php
use function _ takeWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => false ]
]
takeWhile ( $ users , function ( $ value ) { return $ value [ ' active ' ]; })
// => objects for ['barney', 'fred']
等価比較にSameValueZero
使用して、指定されたすべての配列から一意の値の配列を順番に作成します。
引数:
@param array ...$arrays 検査する配列。
戻る:
@return array 結合された値の新しい配列。
例:
<?php
use function _ union ;
union ([ 2 ], [ 1 , 2 ])
// => [2, 1]
このメソッドは、一意性を計算する基準を生成するために各arrays
の要素ごとに呼び出されるiteratee
受け入れる点を除いて、 union
に似ています。結果の値は、値が出現する最初の配列から選択されます。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param array<int,mixed> ...$arrays 検査する配列。
@param callable $iteratee 要素ごとに呼び出される iteratee。
戻る:
@return array 結合された値の新しい配列。
例:
<?php
use function _ unionBy ;
unionBy ([ 2.1 ], [ 1.2 , 2.3 ], ' floor ' )
// => [2.1, 1.2]
// The `_::property` iteratee shorthand.
unionBy ([[ ' x ' => 1 ]], [[ ' x ' => 2 ], [ ' x ' => 1 ]], ' x ' );
// => [['x' => 1], ['x' => 2]]
このメソッドは、 arrays
の要素を比較するために呼び出されるcomparator
を受け入れる点を除いて、 union
に似ています。結果の値は、値が出現する最初の配列から選択されます。コンパレータは 2 つの引数 (arrVal、othVal) を使用して呼び出されます。
引数:
@param array<int,mixed> ...$arrays 検査する配列。
@param callable $comparator 要素ごとに呼び出されるコンパレータ。
戻る:
@return array 結合された値の新しい配列。
例:
<?php
use function _ unionWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ]]
$ others = [[ ' x ' => 1 , ' y ' => 1 ], [ ' x ' => 1 , ' y ' => 2 ]]
unionWith ( $ objects , $ others , ' _::isEqual ' )
// => [['x' => 1, 'y' => 2], ['x' => 2, 'y' => 1], ['x' => 1, 'y' => 1]]
等価比較にSameValueZero
を使用して、重複のないバージョンの配列を作成します。この場合、各要素の最初の出現のみが保持されます。結果値の順序は、配列内での結果値の出現順序によって決まります。
引数:
@param array $array 検査する配列。
戻る:
@return array 新しい重複した空き配列。
例:
<?php
use function _ uniq ;
uniq ([ 2 , 1 , 2 ])
// => [2, 1]s
このメソッドは、一意性を計算する基準を生成するためにarray
内の各要素に対して呼び出されるiteratee
受け入れる点を除いて、 uniq
に似ています。結果値の順序は、配列内での結果値の出現順序によって決まります。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param array $array 検査する配列。
@parammixed $iterateee 要素ごとに呼び出される iteratee。
戻る:
@return array 新しい重複した空き配列。
例:
<?php
use function _ uniqBy ;
uniqBy ([ 2.1 , 1.2 , 2.3 ], ' floor ' )
// => [2.1, 1.2]
このメソッドは、 array
の要素を比較するために呼び出されるcomparator
を受け入れる点を除いて、 uniq
に似ています。結果値の順序は、配列内で発生する順序によって決まります。コンパレータは 2 つの引数 (arrVal、othVal) を使用して呼び出されます。
引数:
@param array $array 検査する配列。
@param callable $comparator 要素ごとに呼び出されるコンパレータ。
戻る:
@return array 新しい重複した空き配列。
例:
<?php
use function _ uniqWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ], [ ' x ' => 1 , ' y ' => 2 ]]
uniqWith ( $ objects , ' _::isEqual ' )
// => [['x' => 1, 'y' => 2], ['x' => 2, 'y' => 1]]
このメソッドは、グループ化された要素の配列を受け入れ、要素を zip 前の構成に再グループ化する配列を作成する点を除けば、 zip
に似ています。
引数:
@param array $array 処理するグループ化された要素の配列。
戻る:
@return array 再グループ化された要素の新しい配列。
例:
<?php
use function _ unzip ;
$ zipped = zip ([ ' a ' , ' b ' ], [ 1 , 2 ], [ true , false ])
// => [['a', 1, true], ['b', 2, false]]
unzip ( $ zipped )
// => [['a', 'b'], [1, 2], [true, false]]
このメソッドは、再グループ化された値をどのように結合するかを指定するiteratee
を受け入れる点を除けば、 unzip
に似ています。 iteratee は、各グループの要素 (...group) を使用して呼び出されます。
引数:
@param array $array 処理するグループ化された要素の配列。
@param (callable | null) $iteratee 再グループ化された値を結合する関数。
戻る:
@return array 再グループ化された要素の新しい配列。
例:
<?php
use function _ unzipWith ;
$ zipped = zip ([ 1 , 2 ], [ 10 , 20 ], [ 100 , 200 ])
// => [[1, 10, 100], [2, 20, 200]]
unzipWith (zipped, ' _::add ' )
// => [3, 30, 300]
等価比較にSameValueZero
使用して、指定されたすべての値を除外した配列を作成します。
注: pull
とは異なり、このメソッドは新しい配列を返します。
引数:
@param array $array 検査する配列。
@param array<int,mixed> $values 除外する値。
戻る:
@return array フィルタリングされた値の新しい配列。
例:
<?php
use function _ without ;
without ([ 2 , 1 , 2 , 3 ], 1 , 2 )
// => [3]
グループ化された要素の配列を作成します。最初の要素には指定された配列の最初の要素が含まれ、2 番目の要素には指定された配列の 2 番目の要素が含まれます。
引数:
@param array ...$arrays 処理する配列。
戻る:
@return array グループ化された要素の新しい配列。
例:
<?php
use function _ zip ;
zip ([ ' a ' , ' b ' ], [ 1 , 2 ], [ true , false ])
// => [['a', 1, true], ['b', 2, false]]
このメソッドはfromPairs
に似ていますが、プロパティ識別子の 1 つと対応する値の 1 つという 2 つの配列を受け入れる点が異なります。
引数:
@param array $props プロパティの識別子。
@param array $values プロパティ値。
戻る:
@return object 新しいオブジェクト。
例:
<?php
use function _ zipObject ;
zipObject ([ ' a ' , ' b ' ], [ 1 , 2 ])
/* => object(stdClass) #210 (2) {
[ " a " ] => int( 1 )
[ " b " ] => int( 2 )
}
*/
このメソッドは、プロパティ パスをサポートする点を除けばzipObject
に似ています。
引数:
@param array $props プロパティの識別子。
@param array $values プロパティ値。
戻る:
@return stdClass 新しいオブジェクト。
例:
<?php
use function _ zipObjectDeep ;
zipObjectDeep ([ ' a.b[0].c ' , ' a.b[1].d ' ], [ 1 , 2 ])
/* => class stdClass #20 (1) {
public $ a => class stdClass #19 (1) {
public $ b =>
array ( 2 ) {
[ 0 ] => class stdClass #17 (1) {
public $ c => int( 1 )
}
[ 1 ] => class stdClass #18 (1) {
public $ d => int( 2 )
}
}
}
}
*/
このメソッドは、グループ化された値をどのように組み合わせるかを指定するiteratee
を受け入れる点を除けば、 zip
に似ています。 iteratee は、各グループの要素 (...group) を使用して呼び出されます。
引数:
@param array<int, (array | callable)> ...$arrays 処理する配列。
@param callable $iteratee グループ化された値を結合する関数。
戻る:
@return array グループ化された要素の新しい配列。
例:
<?php
use function _ zipWith ;
zipWith ([ 1 , 2 ], [ 10 , 20 ], [ 100 , 200 ], function ( $ a , $ b , $ c ) { return $ a + $ b + $ c ; })
// => [111, 222]
iteratee
を介してcollection
の各要素を実行した結果から生成されたキーで構成される配列を作成します。各キーの対応する値は、キーがiteratee
によって返された回数です。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param iterable $collection 反復するコレクション。
@param callable $iteratee キーを変換する反復処理。
戻る:
@return array 合成された集約オブジェクトを返します。
例:
<?php
use function _ countBy ;
countBy ([ 6.1 , 4.2 , 6.3 ], ' floor ' );
// => ['6' => 2, '4' => 1]
// The `property` iteratee shorthand.
countBy ([ ' one ' , ' two ' , ' three ' ], ' strlen ' );
// => ['3' => 2, '5' => 1]
collection
の要素を反復し、要素ごとにiteratee
を呼び出します。 iteratee は 3 つの引数 (値、インデックス|キー、コレクション) を使用して呼び出されます。 Iteratee 関数は、明示的にfalse
を返すことで反復を早期に終了できます。
注:他の「コレクション」メソッドと同様、「長さ」プロパティを持つオブジェクトは配列のように反復されます。この動作を回避するには、オブジェクトの反復にforIn
またはforOwn
使用します。
引数:
@param (配列 | iterable | object) $collection 反復処理するコレクション。
@param callable $iterateee 反復ごとに呼び出される関数。
戻る:
@return (array | object) collection
を返します。
例:
<?php
use function _ each ;
each ([ 1 , 2 ], function ( $ value ) { echo $ value ; })
// => Echoes `1` then `2`.
each (( object ) [ ' a ' => 1 , ' b ' => 2 ], function ( $ value , $ key ) { echo $ key ; });
// => Echoes 'a' then 'b' (iteration order is not guaranteed).
このメソッドは、 collection
の要素を右から左に反復処理することを除いて、 each
と似ています。
引数:
@param (配列 | iterable | object) $collection 反復処理するコレクション。
@param callable $iterateee 反復ごとに呼び出される関数。
戻る:
@return (array | object) collection
を返します。
例:
<?php
use function _ eachRight ;
eachRight ([ 1 , 2 ], function ( $ value ) { echo $ value ; })
// => Echoes `2` then `1`.
array
の要素を反復処理し、すべての要素の配列を返します。 predicate
は true を返します。述語は 3 つの引数 (値、インデックス、配列) を使用して呼び出されます。
注: remove
とは異なり、このメソッドは新しい配列を返します。
引数:
@param iterable $array 反復処理する配列。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array フィルタリングされた新しい配列。
例:
<?php
use function _ filter ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => true ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => false ]
];
filter ( $ users , function ( $ o ) { return ! $ o [ ' active ' ]; });
// => objects for ['fred']
// The `matches` iteratee shorthand.
filter ( $ users , [ ' age ' => 36 , ' active ' => true ]);
// => objects for ['barney']
// The `matchesProperty` iteratee shorthand.
filter ( $ users , [ ' active ' , false ]);
// => objects for ['fred']
// The `property` iteratee shorthand.
filter ( $ users , ' active ' );
// => objects for ['barney']
collection
の要素を反復処理し、最初の要素を返します。 predicate
true を返します。述語は 3 つの引数 (値、インデックス|キー、コレクション) を使用して呼び出されます。
引数:
@param iterable $collection 検査するコレクション。
@param callable $predicate 反復ごとに呼び出される関数。
@param int $fromIndex 検索元のインデックス。
戻る:
@returnmixed 一致した要素を返します。それ以外の場合はnull
返します。
例:
<?php
use function _ find ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => true ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => false ],
[ ' user ' => ' pebbles ' , ' age ' => 1 , ' active ' => true ]
];
find ( $ users , function ( $ o ) { return $ o [ ' age ' ] < 40 ; });
// => object for 'barney'
// The `matches` iteratee shorthand.
find ( $ users , [ ' age ' => 1 , ' active ' => true ]);
// => object for 'pebbles'
// The `matchesProperty` iteratee shorthand.
find ( $ users , [ ' active ' , false ]);
// => object for 'fred'
// The `property` iteratee shorthand.
find ( $ users , ' active ' );
// => object for 'barney'
このメソッドはfind
に似ていますが、 collection
の要素を右から左に反復処理する点が異なります。
引数:
@param iterable $collection 検査するコレクション。
@param callable $predicate 反復ごとに呼び出される関数。
@param int $fromIndex 検索元のインデックス。
戻る:
@returnmixed 一致した要素を返します。それ以外の場合はundefined
返します。
例:
<?php
use function _ findLast ;
findLast ([ 1 , 2 , 3 , 4 ], function ( $ n ) { return $ n % 2 == 1 ; })
// => 3
iteratee
を通じてcollection
内の各要素を実行し、マップされた結果を平坦化することにより、平坦化された値の配列を作成します。 iteratee は 3 つの引数 (値、インデックス|キー、コレクション) を使用して呼び出されます。
引数:
@param iterable $collection 反復するコレクション。
@param callable $iterateee 反復ごとに呼び出される関数。
戻る:
@return array 新しいフラット化された配列。
例:
<?php
use function _ flatMap ;
function duplicate ( $ n ) {
return [ $ n , $ n ]
}
flatMap ([ 1 , 2 ], ' duplicate ' )
// => [1, 1, 2, 2]
このメソッドは、マップされた結果を再帰的に平坦化する点を除けば、 flatMap
に似ています。
引数:
@param iterable $collection 反復処理するコレクション。
@param callable $iterateee 反復ごとに呼び出される関数。
戻る:
@return array 新しいフラット化された配列を返します。
例:
<?php
use function _ flatMapDeep ;
function duplicate ( $ n ) {
return [[[ $ n , $ n ]]];
}
flatMapDeep ([ 1 , 2 ], ' duplicate ' );
// => [1, 1, 2, 2]
このメソッドはflatMap
に似ていますが、マップされた結果をdepth
時間まで再帰的に平坦化する点が異なります。
引数:
@param iterable $collection 反復するコレクション。
@param callable $iterateee 反復ごとに呼び出される関数。
@param int $ Depth 再帰の最大の深さ。
戻る:
@return array 新しいフラット化された配列。
例:
<?php
use function _ flatMapDepth ;
function duplicate ( $ n ) {
return [[[ $ n , $ n ]]]
}
flatMapDepth ([ 1 , 2 ], ' duplicate ' , 2 )
// => [[1, 1], [2, 2]]
iteratee
を介してcollection
の各要素を実行した結果から生成されたキーで構成される配列を作成します。グループ化された値の順序は、 collection
内での値の出現順序によって決まります。各キーの対応する値は、キーの生成を担当する要素の配列です。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param iterable $collection 反復するコレクション。
@param callable $iteratee キーを変換する反復処理。
戻る:
@return array 合成された集約オブジェクトを返します。
例:
<?php
use function _ groupBy ;
groupBy ([ 6.1 , 4.2 , 6.3 ], ' floor ' );
// => ['6' => [6.1, 6.3], '4' => [4.2]]
groupBy ([ ' one ' , ' two ' , ' three ' ], ' strlen ' );
// => ['3' => ['one', 'two'], '5' => ['three']]
collection
内の各要素のpath
にあるメソッドを呼び出し、呼び出された各メソッドの結果の配列を返します。追加の引数は、呼び出された各メソッドに提供されます。 path
が関数の場合、 this
関数はcollection
内の各要素に対して呼び出され、各要素にバインドされます。
引数:
@param iterable $collection 反復処理するコレクション。
@param (配列 | 呼び出し可能 | 文字列) $path 呼び出すメソッドのパス、または反復ごとに呼び出される関数のパス。
@param array $args 各メソッドを呼び出す引数。
戻る:
@return array 結果の配列。
例:
<?php
use function _ invokeMap ;
invokeMap ([[ 5 , 1 , 7 ], [ 3 , 2 , 1 ]], function ( $ result ) { sort ( $ result ); return $ result ;})
// => [[1, 5, 7], [1, 2, 3]]
invokeMap ([ 123 , 456 ], ' str_split ' )
// => [['1', '2', '3'], ['4', '5', '6']]
iteratee
を介してcollection
の各要素を実行した結果から生成されたキーで構成されるオブジェクトを作成します。各キーの対応する値は、キーの生成を担当する最後の要素です。 iteratee は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param iterable $collection 反復するコレクション。
@param callable $iteratee キーを変換する反復処理。
戻る:
@return 構成された集約オブジェクトの配列。
例:
<?php
use function _ keyBy ;
$ array = [
[ ' direction ' => ' left ' , ' code ' => 97 ],
[ ' direction ' => ' right ' , ' code ' => 100 ],
];
keyBy ( $ array , function ( $ o ) { return chr ( $ o [ ' code ' ]); })
// => ['a' => ['direction' => 'left', 'code' => 97], 'd' => ['direction' => 'right', 'code' => 100]]
keyBy ( $ array , ' direction ' );
// => ['left' => ['direction' => 'left', 'code' => 97], 'right' => ['direction' => 'right', 'code' => 100]]
iteratee
を通じてcollection
内の各要素を実行することにより、値の配列を作成します。 iteratee は 3 つの引数 (値、インデックス|キー、コレクション) を使用して呼び出されます。
多くの lodash-php メソッドは_::every
、 _::filter
、 _::map
、 _::mapValues
、 _::reject
、 _::some
などのメソッドの反復として機能するように保護されています。
保護されたメソッドは次のとおりです: ary
、 chunk
、 curry
、 curryRight
、 drop
、 dropRight
、 every
、 fill
、 invert
、 parseInt
、 random
、 range
、 rangeRight
、 repeat
、 sampleSize
、 slice
、 some
、 sortBy
、 split
、 take
、 takeRight
、 template
、 trim
、 trimEnd
、 trimStart
、およびwords
引数:
@param (配列 | オブジェクト) $collection 反復処理するコレクション。
@param (呼び出し可能 | 文字列 | 配列) $iteratee 反復ごとに呼び出される関数。
戻る:
@return array 新しいマップされた配列を返します。
例:
<?php
use function _ map ;
function square ( int $ n ) {
return $ n * $ n ;
}
map ([ 4 , 8 ], $ square );
// => [16, 64]
map (( object ) [ ' a ' => 4 , ' b ' => 8 ], $ square );
// => [16, 64] (iteration order is not guaranteed)
$ users = [
[ ' user ' => ' barney ' ],
[ ' user ' => ' fred ' ]
];
// The `property` iteratee shorthand.
map ( $ users , ' user ' );
// => ['barney', 'fred']
このメソッドは、並べ替えの基準となる反復の並べ替え順序を指定できる点を除けばsortBy
に似ています。 orders
が指定されていない場合、すべての値が昇順で並べ替えられます。それ以外の場合、対応する値の降順の並べ替え順序には「desc」、昇順の並べ替え順序には「asc」を指定します。
引数:
@param (iterable | null) $collection 反復処理するコレクション。
@param (array[] | callable[] | string[]) $iteratee 並べ替えの基準となる iteratee。
@param string[] $orders iteratees
のソート順序。
戻る:
@return array 新しくソートされた配列。
例:
<?php
use function _ orderBy ;
$ users = [
[ ' user ' => ' fred ' , ' age ' => 48 ],
[ ' user ' => ' barney ' , ' age ' => 34 ],
[ ' user ' => ' fred ' , ' age ' => 40 ],
[ ' user ' => ' barney ' , ' age ' => 36 ]
]
// Sort by `user` in ascending order and by `age` in descending order.
orderBy ( $ users , [ ' user ' , ' age ' ], [ ' asc ' , ' desc ' ])
// => [['user' => 'barney', 'age' => 36], ['user' => 'barney', 'age' => 34], ['user' => 'fred', 'age' => 48], ['user' => 'fred', 'age' => 40]]
2 つのグループに分割された要素の配列を作成します。最初のグループにはpredicate
true を返す要素が含まれ、2 番目のグループにはpredicate
falsey を返す要素が含まれます。述語は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param iterable $collection 反復処理するコレクション。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array グループ化された要素の配列。
例:
<?php
use function _ partition ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => false ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' age ' => 1 , ' active ' => false ]
];
partition ( $ users , function ( $ user ) { return $ user [ ' active ' ]; })
// => objects for [['fred'], ['barney', 'pebbles']]
collection
iteratee
を通じてcollection
内の各要素を実行した累積結果である値に減らします。連続する各呼び出しには、前の呼び出しの戻り値が提供されます。 accumulator
が指定されていない場合は、 collection
の最初の要素が初期値として使用されます。 iteratee は 4 つの引数 (アキュムレータ、値、インデックス|キー、コレクション) を使用して呼び出されます。
多くの lodash メソッドは、 reduce
、 reduceRight
、 transform
などのメソッドの反復対象として機能するように保護されています。
保護されたメソッドは次のとおりです: assign
、 defaults
、 defaultsDeep
、 includes
、 merge
、 orderBy
、およびsortBy
引数:
@param iterable $collection 反復するコレクション。
@parammixed$iterateee 反復ごとに呼び出される関数。
@parammixed $accumulator 初期値。
戻る:
@returnmixed 累積値を返します。
例:
<?php
use function _ reduce ;
reduce ([ 1 , 2 ], function ( $ sum , $ n ) { return $ sum + $ n ; }, 0 )
// => 3
reduce ([ ' a ' => 1 , ' b ' => 2 , ' c ' => 1 ], function ( $ result , $ value , $ key ) {
if (! isset ( $ result [ $ value ])) {
$ result [ $ value ] = [];
}
$ result [ $ value ][] = $ key ;
return $ result ;
}, [])
// => ['1' => ['a', 'c'], '2' => ['b']] (iteration order is not guaranteed)
このメソッドは、 collection
の要素を右から左に反復処理することを除いて、 reduce
に似ています。
引数:
@param iterable $collection 反復するコレクション。
@parammixed$iterateee 反復ごとに呼び出される関数。
@parammixed $accumulator 初期値。
戻る:
@returnmixed 累積値を返します。
例:
<?php
use function _ reduceRight ;
$ array = [[ 0 , 1 ], [ 2 , 3 ], [ 4 , 5 ]];
reduceRight ( array , (flattened, other) => flattened. concat (other), [])
// => [4, 5, 2, 3, 0, 1]
このメソッドはfilter
の逆で、 predicate
true を返さないcollection
の要素を返します。
引数:
@param iterable $collection 反復するコレクション。
@param callable $predicate 反復ごとに呼び出される関数。
戻る:
@return array フィルタリングされた新しい配列。
例:
<?php
use function _ reject ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => false ]
]
reject ( $ users , ' active ' )
// => objects for ['fred']
配列値の長さまたはオブジェクトのパブリック プロパティの数を返すことにより、 collection
のサイズを取得します。
引数:
@param (配列 | オブジェクト | 文字列) $collection 検査するコレクション。
戻る:
@return int コレクションのサイズを返します。
例:
<?php
use function _ size ;
size ([ 1 , 2 , 3 ]);
// => 3
size ( new class { public $ a = 1 ; public $ b = 2 ; private $ c = 3 ; });
// => 2
size ( ' pebbles ' );
// => 7
predicate
collection
の要素に対して true を返すかどうかを確認します。 predicate
真を返すと反復が停止されます。述語は 3 つの引数 (値、インデックス|キー、コレクション) を使用して呼び出されます。
引数:
@param iterable $collection 反復するコレクション。
@param (呼び出し可能 | 文字列 | 配列) $predicate 反復ごとに呼び出される関数。
戻る:
@return boolean いずれかの要素が述語チェックに合格した場合はtrue
を返し、それ以外の場合はfalse
返します。
例:
<?php
use function _ some ;
some ([ null , 0 , ' yes ' , false ], , function ( $ value ) { return is_bool ( $ value ); }));
// => true
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => false ]
];
// The `matches` iteratee shorthand.
some ( $ users , [ ' user ' => ' barney ' , ' active ' => false ]);
// => false
// The `matchesProperty` iteratee shorthand.
some ( $ users , [ ' active ' , false ]);
// => true
// The `property` iteratee shorthand.
some ( $ users , ' active ' );
// => true
各反復処理を通じてコレクション内の各要素を実行した結果に従って昇順に並べ替えられた要素の配列を作成します。このメソッドは安定した並べ替えを実行します。つまり、等しい要素の元の並べ替え順序が保持されます。反復対象は 1 つの引数 (値) を使用して呼び出されます。
引数:
@param (array | object | null) $collection 反復処理するコレクション。
@param (callable | callable[]) $iteratees 並べ替えの基準となる反復。
戻る:
@return array 新しくソートされた配列を返します。
例:
<?php
use function _ sortBy ;
$ users = [
[ ' user ' => ' fred ' , ' age ' => 48 ],
[ ' user ' => ' barney ' , ' age ' => 36 ],
[ ' user ' => ' fred ' , ' age ' => 40 ],
[ ' user ' => ' barney ' , ' age ' => 34 ],
];
sortBy ( $ users , [ function ( $ o ) { return $ o [ ' user ' ]; }]);
// => [['user' => 'barney', 'age' => 36], ['user' => 'barney', 'age' => 34], ['user' => 'fred', 'age' => 48], ['user' => 'fred', 'age' => 40]]
sortBy ( $ users , [ ' user ' , ' age ' ]);
// => [['user' => 'barney', 'age' => 34], ['user' => 'barney', 'age' => 36], ['user' => 'fred', 'age' => 40], ['user' => 'fred', 'age' => 48]]
Unix エポック (1970 年 1 月 1 日 00:00:00 UTC) から経過したミリ秒数のタイムスタンプを取得します。
引数:
戻る:
@return int タイムスタンプを返します。
例:
<?php
use function _ now ;
now ();
// => 1511180325735
before
とは逆です。このメソッドは、 n
回以上呼び出されるとfunc
呼び出す関数を作成します。
引数:
@param int $n func
が呼び出されるまでの呼び出しの数。
@param Callable $func 制限する関数。
戻る:
@return Callable 新しい制限付き関数を返します。
例:
<?php
use function _ after ;
$ saves = [ ' profile ' , ' settings ' ];
$ done = after ( count ( $ saves ), function () {
echo ' done saving! ' ;
});
forEach ( $ saves , function ( $ type ) use ( $ done ) {
asyncSave ([ ' type ' => $ type , ' complete ' => $ done ]);
});
// => Prints 'done saving!' after the two async saves have completed.
追加の引数を無視して、最大n
の引数を指定してfunc
を呼び出す関数を作成します。
引数:
@param callable $func 引数に上限を設ける関数。
@param int $n アリティの上限。
戻る:
@return Callable 新しい上限付き関数を返します。
例:
<?php
use function _ ary ;
map ([ ' 6 ' , ' 8 ' , ' 10 ' ], ary ( ' intval ' , 1 ));
// => [6, 8, 10]
n
回未満の呼び出しの間に、作成された関数の引数を使用してfunc
呼び出す関数を作成します。作成された関数に対する後続の呼び出しでは、最後のfunc
呼び出しの結果が返されます。
引数:
@param int $n func
が呼び出されなくなる呼び出しの数。
@param callable $func 制限する関数。
戻る:
@return callable 新しい制限付き関数を返します。
例:
<?php
use function _ before ;
$ users = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 ];
$ result = uniqBy ( map ( $ users , before ( 5 , [ $ repository , ' find ' ])), ' id ' )
// => Fetch up to 4 results.
受け取る引数の先頭にobject
とpartials
のthis
バインディングを付けてfunc
を呼び出す関数を作成します。
引数:
@param callable $function バインドする関数。
@param (object |mixed) $object func
のobject
バインディング。
@param array<int,mixed> $partials 部分的に適用される引数。
戻る:
@return callable 新しいバインドされた関数を返します。
例:
<?php
use function _ bind ;
function greet ( $ greeting , $ punctuation ) {
return $ greeting . ' ' . $ this -> user . $ punctuation ;
}
$ object = $ object = new class {
public $ user = ' fred ' ;
};
$ bound = bind ( ' greet ' , $ object , ' hi ' );
$ bound ( ' ! ' );
// => 'hi fred!'
受け取る引数の先頭に$partials
付加して、 $object
のメソッド$function
呼び出す関数を作成します。
このメソッドは、バインドされた関数が再定義されたメソッドやまだ存在しないメソッドを参照できるようにする点でbind
とは異なります。
引数:
@param object $object メソッドを呼び出すオブジェクト。
@param string $function メソッドの名前。
@param array<int,mixed> $partials 部分的に適用される引数。
戻る:
@return callable 新しいバインドされた関数を返します。
例:
<?php
use function _ bindKey ;
$ object = new class {
private $ user = ' fred ' ;
function greet ( $ greeting , $ punctuation ) {
return $ greeting . ' ' . $ this -> user . $ punctuation ;
}
};
$ bound = bindKey ( $ object , ' greet ' , ' hi ' );
$ bound ( ' ! ' );
// => 'hi fred!'
func
の引数を受け入れる関数を作成し、 arity
引数の引数が指定されている場合はfunc
を呼び出してその結果を返すか、残りのfunc
引数を受け入れる関数を返します。 func.length
が十分でない場合は、 func
のアリティを指定できます。
_.curry.placeholder
値 (モノリシック ビルドではデフォルトで_
は、指定された引数のプレースホルダーとして使用できます。
注:このメソッドは、カリー化された関数の「長さ」プロパティを設定しません。
引数:
@param callable $func カリー化する関数。
@param (int | null) $arity func
のアリティ。
戻る:
@return callable 新しいカリー化された関数を返します。
例:
<?php
use function _ curry ;
$ abc = function ( $ a , $ b , $ c ) {
return [ $ a , $ b , $ c ];
};
$ curried = curry ( $ abc );
$ curried ( 1 )( 2 )( 3 );
// => [1, 2, 3]
$ curried ( 1 , 2 )( 3 );
// => [1, 2, 3]
$ curried ( 1 , 2 , 3 );
// => [1, 2, 3]
// Curried with placeholders.
$ curried ( 1 )(_, 3 )( 2 );
// => [1, 2, 3]
ミリ秒wait
後にfunc
呼び出します。追加の引数は、 func
の呼び出し時に指定されます。
引数:
@param callable $func 遅延する関数。
@param int $wait 呼び出しを遅延するミリ秒数。
@param array<int,mixed> $args
戻る:
@return int タイマー ID。
例:
<?php
use function _ delay ;
delay ( function ( $ text ) {
echo $ text ;
}, 1000 , ' later ' );
// => Echo 'later' after one second.
引数を逆にしてfunc
呼び出す関数を作成します。
引数:
@param callable $func 引数を反転する関数。
戻る:
@return callable 新しい反転された関数を返します。
例:
<?php
use function _ flip ;
$ flipped = flip ( function () {
return func_get_args ();
});
flipped ( ' a ' , ' b ' , ' c ' , ' d ' );
// => ['d', 'c', 'b', 'a']
func
の結果をメモ化する関数を作成します。 resolver
が提供されている場合、メモ化された関数に提供された引数に基づいて、結果を保存するためのキャッシュ キーが決定されます。デフォルトでは、メモ化された関数に指定された最初の引数がマップ キャッシュ キーとして使用されます。
注:キャッシュは、メモ化された関数のcache
プロパティとして公開されます。その作成は、 _.memoize.Cache
コンストラクターを、そのインスタンスがclear
、 delete
、 get
、 has
、およびset
のMap
メソッド インターフェイスを実装するコンストラクターに置き換えることによってカスタマイズできます。
引数:
@param callable $func 出力をメモ化する関数。
@param (callable | null) $resolver キャッシュキーを解決する関数。
戻る:
@return callable 新しいメモ化された関数を返します。
例:
<?php
use function _ memoize ;
$ object = [ ' a ' => 1 , ' b ' => 2 ];
$ other = [ ' c ' => 3 , ' d ' => 4 ];
$ values = memoize ( ' _values ' );
$ values ( $ object );
// => [1, 2]
$ values ( $ other );
// => [3, 4]
$ object [ ' a ' ] = 2 ;
$ values ( $ object );
// => [1, 2]
// Modify the result cache.
$ values -> cache -> set ( $ object , [ ' a ' , ' b ' ]);
$ values ( $ object );
// => ['a', 'b']
述語func
の結果を否定する関数を作成します。
引数:
@param callable $predicate 否定する述語。
戻る:
@return callable 新しい否定された関数を返します。
例:
<?php
use function _ negate ;
function isEven ( $ n ) {
return $ n % 2 == 0 ;
}
filter ([ 1 , 2 , 3 , 4 , 5 , 6 ], negate ( $ isEven ));
// => [1, 3, 5]
func
1 回の呼び出しに制限された関数を作成します。関数を繰り返し呼び出すと、最初の呼び出しの値が返されます。 func
作成された関数の引数を使用して呼び出されます。
引数:
@param callable $func 制限する関数。
戻る:
@return は新しい制限された関数を呼び出し可能です。
例:
<?php
use function _ once ;
$ initialize = once ( ' createApplication ' );
$ initialize ();
$ initialize ();
// => `createApplication` is invoked once
引数を変換してfunc
呼び出す関数を作成します。
引数:
@param callable $func ラップする関数。
@param callable[] $transforms 引数は変換します。
戻る:
@return 新しい関数を呼び出すことができます。
例:
<?php
use function _ overArgs ;
function doubled ( $ n ) {
return $ n * 2 ;
}
function square ( $ n ) {
return $ n * $ n ;
}
$ func = overArgs ( function ( $ x , $ y ) {
return [ $ x , $ y ];
}, [ ' square ' , ' doubled ' ]);
$ func ( 9 , 3 );
// => [81, 6]
$ func ( 10 , 5 );
// => [100, 10]
受け取った引数の先頭にpartials
を付けてfunc
呼び出す関数を作成します。
引数:
@param callable $func 引数を部分的に適用する関数。
@param array<int,mixed> $partials 部分的に適用される引数。
戻る:
@return callable 部分的に適用された新しい関数を返します。
例:
<?php
use function _ partial ;
function greet ( $ greeting , $ name ) {
return $ greeting . ' ' . $ name ;
}
$ sayHelloTo = partial ( ' greet ' , ' hello ' );
$ sayHelloTo ( ' fred ' );
// => 'hello fred'
作成した関数のthis
バインディングと、配列として提供されたstart
以降の引数を使用してfunc
を呼び出す関数を作成します。
引数:
@param callable $func 残りのパラメータを適用する関数。
@param (int | null) $start 残りのパラメータの開始位置。
戻る:
@return callable 新しい関数を返します。
例:
<?php
use function _ rest ;
$ say = rest ( function ( $ what , $ names ) {
return $ what . ' ' . implode ( ' , ' , initial ( $ names )) .
( size ( $ names ) > 1 ? ' , & ' : '' ) . last ( $ names );
});
$ say ( ' hello ' , ' fred ' , ' barney ' , ' pebbles ' );
// => 'hello fred, barney, & pebbles'
Function#apply
と同様に、 create 関数と引数の配列のthis
バインディングを使用してfunc
呼び出す関数を作成します。
注:このメソッドはスプレッド演算子に基づいています。
引数:
@param callable $func 引数を分散する関数。
@param int $start スプレッドの開始位置。
戻る:
@return callable 新しい関数を返します。
例:
<?php
use function _ spread ;
$ say = spread ( function ( $ who , $ what ) {
return $ who . ' says ' . $ what ;
});
$ say ([ ' fred ' , ' hello ' ]);
// => 'fred says hello'
追加の引数を無視して、最大 1 つの引数を受け入れる関数を作成します。
引数:
@param callable $func 引数に上限を設ける関数。
戻る:
@return は新しい上限付き関数を呼び出すことができます。
例:
<?php
use function _ unary ;
map ([ ' 6 ' , ' 8 ' , ' 10 ' ], unary ( ' intval ' ));
// => [6, 8, 10]
最初の引数としてvalue
wrapper
に提供する関数を作成します。関数に提供される追加の引数は、 wrapper
に提供される引数に追加されます。
引数:
@parammixed $value ラップする値。
@Param Callable $ラッパーラッパー関数。
戻る:
@returnは新しい関数を呼び出します。
例:
<?php
use function _ wrap ;
$ p = wrap ( ' _escape ' , function ( $ func , $ text ) {
return ' <p> ' . $ func ( $ text ) . ' </p> ' ;
});
$ p ( ' fred, barney, & pebbles ' );
// => '<p>fred, barney, & pebbles</p>'
2つの値の比較を実行して、それらが同等かどうかを判断します。
引数:
@Param Mixed $は比較する値を値化します。
@param Mixed $他の値を比較する他の値。
戻る:
@return booleanは、値が同等でfalse
場合にtrue
を返します。
例:
<?php
use function _ eq ;
$ object = ( object ) [ ' a ' => 1 ];
$ other = ( object ) [ ' a ' => 1 ];
eq ( $ object , $ object );
// => true
eq ( $ object , $ other );
// => false
eq ( ' a ' , ' a ' );
// => true
eq ([ ' a ' ], ( object ) [ ' a ' ]);
// => false
eq ( INF , INF );
// => true
2つの値間の深い比較を実行して、それらが同等かどうかを判断します。
注:このメソッドは、配列、ブール人、データタイムオブジェクト、例外オブジェクト、splobjectStorage、数字、文字列、タイプ付き配列、リソース、DOMノードの比較をサポートします。オブジェクトは、継承されていない、列挙可能な特性によって比較されます。
引数:
@Param Mixed $は比較する値を値化します。
@param Mixed $他の値を比較する他の値。
戻る:
@return boolは、値が同等である場合にtrue
false
返します。
例:
<?php
use function _ isEqual ;
$ object = [ ' a ' => 1 ]
$ other = [ ' a ' => ' 1 ' ]
isEqual ( $ object , $ other )
// => true
$ object === $ other
// => false
value
Exception
、 ParseError
、 error , Throwable
, DOMException
、 pdoexception`、objectであるかどうかを確認します。
引数:
@param Mixed $ value chick noce conce。
戻る:
@return booleanは、 value
がエラーオブジェクトである場合にtrue
false
返します。
例:
<?php
use function _ isError ;
isError ( new Exception ())
// => true
isError (Exception::Class)
// => false
2つの番号を追加します。
引数:
@param(int | float | string)$追加で最初の数字をオーガンします。
@param(int | float | string)$追加で2番目の番号を加えます。
戻る:
@return(int | float)合計を返します。
例:
<?php
use function _ add ;
add ( 6 , 4 );
// => 10
array
の最大値を計算します。 array
が空または偽の場合、nullが返されます。
引数:
@param(array | null)$アレイアレイを反復します。
戻る:
@return(int | null)最大値を返します。
例:
<?php
use function _ max ;
max ([ 4 , 2 , 8 , 6 ]);
// => 8
max ([]);
// => null
この方法は、値がランク付けされている基準を生成するためにarray
内の各要素に対して呼び出されるiteratee
を受け入れることを除いて、 max
のようなものです。 Iterateeは1つの引数で呼び出されます:(値)。
引数:
@param array $ arrayアレイは反復します。
@param(callable | string)$ iteratee要素ごとに呼び出された反復。
戻る:
@return Mixedは最大値を返します。
例:
<?php
use function _ maxBy ;
$ objects = [[ ' n ' => 1 ], [ ' n ' => 2 ]];
maxBy ( $ objects , function ( $ o ) { return $ o [ ' n ' ]; });
// => ['n' => 2]
// The `property` iteratee shorthand.
maxBy ( $ objects , ' n ' );
// => ['n' => 2]
包括的なlower
とupper
内のクランプnumber
。
引数:
@param int $番号クランプの番号。
@param int $下限を下げます。
@param int $上限の上。
戻る:
@return intクランプ番号を返します。
例:
<?php
use function _ clamp ;
clamp (- 10 , - 5 , 5 )
// => -5
clamp ( 10 , - 5 , 5 )
// => 5
number
がstart
とまでの間にあるかどうかをチェックしますが、含まれていませんが、 end
。 end
が指定されていない場合、 start
からstart
てから0
に設定するように設定されています。 start
がend
より大きい場合、パラメージは交換され、負の範囲をサポートします。
引数:
@param float $ numberチェックする番号。
@param float $範囲の開始を開始します。
@param float $範囲の終わり。
戻る:
@return booleanは、 number
が範囲にある場合にtrue
false
返します。
例:
<?php
use function _ inRange ;
inRange ( 3 , 2 , 4 )
// => true
inRange ( 4 , 8 )
// => true
inRange ( 4 , 2 )
// => false
inRange ( 2 , 2 )
// => false
inRange ( 1.2 , 2 )
// => true
inRange ( 5.2 , 4 )
// => false
inRange (- 3 , - 2 , - 6 )
// => true
包括的なlower
とupper
の間に乱数を生成します。 1つの引数のみが提供されている場合、 0
数と指定された数値が返されます。 floating
がtrue
である場合、またはlower
またはupper
いずれかがフロートの場合、整数の代わりにフローティングポイント数が返されます。
引数:
@param(int | float | bool)$下限を下げます。
@param(int | float | bool)$上限の上。
@param(bool | null)$ floatingフローティングポイント数を返すように指定します。
戻る:
@return(int | float)乱数を返します。
例:
<?php
use function _ random ;
random ( 0 , 5 )
// => an integer between 0 and 5
random ( 5 )
// => also an integer between 0 and 5
random ( 5 , true )
// => a floating-point number between 0 and 5
random ( 1.2 , 5.2 )
// => a floating-point number between 1.2 and 5.2
オブジェクトのパスで値を取得します。解決された値がnullの場合、defaultvalueはその場所で返されます。
引数:
@param Mixed $オブジェクト。アソシティブ配列またはオブジェクトから値を取得する
@param(配列|文字列)$パスドット分離または文字列の配列
@Param Mixed $ defaultValue(オプション)未解決の値またはヌル値に対して返される値。
戻る:
@return Mixedは解決された値を返します。
例:
<?php
use function _ get ;
$ sampleArray = [ " key1 " => [ " key2 " => [ " key3 " => " val1 " , " key4 " => "" ]]];
get ( $ sampleArray , ' key1.key2.key3 ' );
// => "val1"
get ( $ sampleArray , ' key1.key2.key5 ' , " default " );
// => "default"
get ( $ sampleArray , ' key1.key2.key4 ' , " default " );
// => ""
選択されたobject
プロパティで構成されるオブジェクトを作成します。
引数:
@paramオブジェクト$オブジェクトソースオブジェクト。
@Param(String | String [])$ PATHS PATHS PASTS THE PLOCTS PICK。
戻る:
@return stdclass新しいオブジェクトを返します。
例:
<?php
use function _ pick ;
$ object = ( object ) [ ' a ' => 1 , ' b ' => ' 2 ' , ' c ' => 3 ];
pick ( $ object , [ ' a ' , ' c ' ]);
// => (object) ['a' => 1, 'c' => 3]
object
predicate
で構成されるオブジェクトを作成します。述語は、2つの引数で呼び出されます:(値、キー)。
引数:
@param(object | null)$オブジェクトソースオブジェクト。
@Param Callable $は、プロパティごとに呼び出された関数を述べています。
戻る:
@return stdclass新しいオブジェクトを返します。
例:
<?php
use function _ pickBy ;
$ object = ( object ) [ ' a ' => 1 , ' b ' => ' abc ' , ' c ' => 3 ];
pickBy (object, ' is_numeric ' );
// => (object) ['a' => 1, 'c' => 3]
明示的なメソッドチェーンシーケンスを有効にしてvalue
ラップするlodash
ラッパーインスタンスを作成します。このようなシーケンスの結果は、 ->value()
で包装する必要があります。
引数:
@param Mixed $ value the value to wrap。
戻る:
@return _新しいlodash
ラッパーインスタンスを返します。
例:
<?php
use function _ chain ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 ],
[ ' user ' => ' fred ' , ' age ' => 40 ],
[ ' user ' => ' pebbles ' , ' age ' => 1 ],
];
$ youngest = chain ( $ users )
-> sortBy ( ' age ' )
-> map ( function ( $ o ) {
return $ o [ ' user ' ] . ' is ' . $ o [ ' age ' ];
})
-> head ()
-> value ();
// => 'pebbles is 1'
string
キャメルケースに変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return stringは、ラクダケースの弦を返します。
例:
<?php
use function _ camelCase ;
camelCase ( ' Foo Bar ' )
// => 'fooBar'
camelCase ( ' --foo-bar-- ' )
// => 'fooBar'
camelCase ( ' __FOO_BAR__ ' )
// => 'fooBar'
string
の最初の文字を大文字に変換し、残りを小文字に変換します。
引数:
@param文字列$文字列文字列を大文字にします。
戻る:
@return文字列大文字の文字列を返します。
例:
<?php
use function _ capitalize ;
capitalize ( ' FRED ' )
// => 'Fred'
[latin-1サプリメント](https => // string
)および[latin extend-a](https => // en.wikipedia。 org/wiki/latin_extended-a)基本的なラテン文字への文字と削除[diacritical marks](https => // en.wikipedia.org/wiki/combining_diacritical_marks)。
引数:
@Param String $ String String to Deburr。
戻る:
@return文字列は、討論された文字列を返します。
例:
<?php
use function _ deburr ;
deburr ( ' déjà vu ' )
// => 'deja vu'
string
指定されたターゲット文字列で終了するかどうかを確認します。
引数:
@Param String $文字列検査する文字列。
@Param String $ターゲット文字列を検索します。
@param int $は、検索する位置を配置します。
戻る:
@return booleanは、 string
target
で終了する場合、 true
false
返します。
例:
<?php
use function _ endsWith ;
endsWith ( ' abc ' , ' c ' )
// => true
endsWith ( ' abc ' , ' b ' )
// => false
endsWith ( ' abc ' , ' b ' , 2 )
// => true
文字を "&"、 "<"、 ">"、 '"'、および" '" string
、対応するHTMLエンティティに変換します。
「>」文字は対称性のために脱出されますが、「>」や「/」などの文字は、HTMLで逃げる必要はなく、タグの一部または引用されていない属性値の一部でない限り、特別な意味がありません。詳細については、Mathias Bynensの記事(「半関連の楽しみ」の下)を参照してください。
HTMLを使用する場合は、XSSベクターを減らすために常に属性値を引用する必要があります。
引数:
@Param String $ String String The String。
戻る:
@return文字列は、逃げた文字列を返します。
例:
<?php
use function _ escape ;
escape ( ' fred, barney, & pebbles ' )
// => 'fred, barney, & pebbles'
RegExp
特殊文字 "^"^"、" $ "、" "、"。 "、"*"、"+"、"? "("、 ")、"、 "、"]、 " "、"} "、および「|」 string
で。
引数:
@Param String $ String String The String。
戻る:
@return文字列は、逃げた文字列を返します。
例:
<?php
use function _ escapeRegExp ;
escapeRegExp ( ' [lodash](https://lodash.com/) ' )
// => '[lodash](https://lodash.com/)'
string
ケバブケースに変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列は、ケバブケースの弦を返します。
例:
<?php
use function _ kebabCase ;
kebabCase ( ' Foo Bar ' )
// => 'foo-bar'
kebabCase ( ' fooBar ' )
// => 'foo-bar'
kebabCase ( ' __FOO_BAR__ ' )
// => 'foo-bar'
スペースを分離した単語として、 string
小文字に変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列は、下部のケース型の文字列を返します。
例:
<?php
use function _ lowerCase ;
lowerCase ( ' --Foo-Bar-- ' )
// => 'foo bar'
lowerCase ( ' fooBar ' )
// => 'foo bar'
lowerCase ( ' __FOO_BAR__ ' )
// => 'foo bar'
string
の最初の文字を小文字に変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列変換された文字列を返します。
例:
<?php
use function _ lowerFirst ;
lowerFirst ( ' Fred ' )
// => 'fred'
lowerFirst ( ' FRED ' )
// => 'fRED'
length
よりも短い場合、左側と右側にパッドstring
列。パディングキャラクターは、 length
で均等に分割できない場合に切り捨てられます。
引数:
@param文字列$文字列文字列をパッドに。
@param int $長さのパディング長。
@Param String $は、パディングとして使用される文字列を充電します。
戻る:
@return文字列パッド付き文字列を返します。
例:
<?php
use function _ pad ;
pad ( ' abc ' , 8 )
// => ' abc '
pad ( ' abc ' , 8 , ' _- ' )
// => '_-abc_-_'
pad ( ' abc ' , 2 )
// => 'abc'
length
よりも短い場合は、右側のパッドstring
。パディングキャラクターは、 length
超えた場合に切り捨てられます。
引数:
@param文字列$文字列文字列をパッドに。
@param int $長さのパディング長。
@Param String $は、パディングとして使用される文字列を充電します。
戻る:
@return文字列パッド付き文字列を返します。
例:
<?php
use function _ padEnd ;
padEnd ( ' abc ' , 6 )
// => 'abc '
padEnd ( ' abc ' , 6 , ' _- ' )
// => 'abc_-_'
padEnd ( ' abc ' , 2 )
// => 'abc'
length
よりも短い場合、左側のパッドstring
。パディングキャラクターは、 length
超えた場合に切り捨てられます。
s議論:
@Param String $ string = ''文字列からパッド。
@param int $長さのパディング長。
@Param String $は、パディングとして使用される文字列を充電します。
戻る:
@return文字列パッド付き文字列を返します。
例:
<?php
use function _ padStart ;
padStart ( ' abc ' , 6 )
// => ' abc'
padStart ( ' abc ' , 6 , ' _- ' )
// => '_-_abc'
padStart ( ' abc ' , 2 )
// => 'abc'
string
指定された基数の整数に変換します。 radix
がundefined
の場合、または0
場合、 string
が16進数である場合を除き、 10
のradix
が使用されます。この場合、 16
のradix
が使用されます。
注:この方法では、PHPの組み込み整数キャストを使用します。これは、必ずしもparseInt
のES5実装とは一致しません。
引数:
@param(int | float | string)$ string string the string convert。
@param int $ radix string
by。
戻る:
@return int変換された整数を返します。
例:
<?php
use function _ parseInt ;
parseInt ( ' 08 ' )
// => 8
指定された文字列n
回を繰り返します。
引数:
@Param String $ STRING STRINGを繰り返します。
@param int $ n文字列を繰り返す回数。
戻る:
@return文字列は、繰り返される文字列を返します。
例:
<?php
use function _ repeat ;
repeat ( ' * ' , 3 )
// => '***'
repeat ( ' abc ' , 2 )
// => 'abcabc'
repeat ( ' abc ' , 0 )
// => ''
string
のpattern
の一致をreplacement
して置き換えます。
注:この方法はString#replace
に基づいています。
引数:
@param文字列$文字列に変更する文字列。
@Param String $は、置き換えるパターンをパターンします。
@param(callable | string)$交換マッチ交換。
戻る:
@return文字列変更された文字列を返します。
例:
<?php
use function _ replace ;
replace ( ' Hi Fred ' , ' Fred ' , ' Barney ' )
// => 'Hi Barney'
string
スネークケースに変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@Return Stringは、ヘビケースの弦を返します。
例:
<?php
use function _ snakeCase ;
snakeCase ( ' Foo Bar ' )
// => 'foo_bar'
snakeCase ( ' fooBar ' )
// => 'foo_bar'
snakeCase ( ' --FOO-BAR-- ' )
// => 'foo_bar'
separator
によってstring
を分割します。
注:この方法はString#split
に基づいています。
引数:
@param文字列$ string string to split。
@param string $分離器分離パターンを分割します。
@param int $は、結果を切り捨てるために長さを制限します。
戻る:
@return配列は文字列セグメントを返します。
例:
<?php
use function _ split ;
split ( ' a-b-c ' , ' - ' , 2 )
// => ['a', 'b']
string
ケースを開始するために変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列は、開始ケースの文字列を返します。
例:
<?php
use function _ startCase ;
startCase ( ' --foo-bar-- ' )
// => 'Foo Bar'
startCase ( ' fooBar ' )
// => 'Foo Bar'
startCase ( ' __FOO_BAR__ ' )
// => 'FOO BAR'
string
指定されたターゲット文字列で始まるかどうかを確認します。
引数:
@Param String $文字列検査する文字列。
@Param String $ターゲット文字列を検索します。
@param int $から検索する位置を配置します。
戻る:
@return booleanはfalse
string
target
で始まる場合にtrue
を返します。
例:
<?php
use function _ startsWith ;
startsWith ( ' abc ' , ' a ' )
// => true
startsWith ( ' abc ' , ' b ' )
// => false
startsWith ( ' abc ' , ' b ' , 1 )
// => true
「補間」デリミター、HTMLエスケープ補間データプロパティの「エスケープ」デリミターのデータプロパティを補間するコンパイルされたテンプレート関数を作成し、「評価」デリミターでPHPを実行します。データプロパティは、テンプレート内の自由変数としてアクセスできます。設定オブジェクトが指定されている場合、 $templateSettings
値よりも優先されます。
Regexp $ options ['Escape'] = _ :: $ Templatesettings ['Escape'] HTML「ESACE」デリミター。 regexp $ options ['evaluate'] = _ :: $ templatesettings ['evaluate'] "evaluate" delimiter。 array $ options ['Imports'] = _ :: $ semplatesettings ['Imports']フリー変数としてテンプレートにインポートするオブジェクト。 regexp $ options ['interporate'] = _ :: $ templatesettings ['interporate']「補間」デリミター。
引数:
@param文字列$文字列テンプレート文字列。
@Param Array $オプションオプションアレイ。
戻る:
@return callableコンパイルされたテンプレート関数を返します。
例:
<?php
use function _ template ;
// Use the "interpolate" delimiter to create a compiled template.
$ compiled = template ( ' hello <%= user %>! ' )
$ compiled ([ ' user ' => ' fred ' ])
// => 'hello fred!'
// Use the HTML "escape" delimiter to escape data property values.
$ compiled = template ( ' <b><%- value %></b> ' )
$ compiled ([ ' value ' => ' <script> ' ])
// => '<b><script></b>'
// Use the "evaluate" delimiter to execute JavaScript and generate HTML.
$ compiled = template ( ' <% foreach($users as $user) { %><li><%- user %></li><% }%> ' )
$ compiled ([ ' users ' => [ ' fred ' , ' barney ' ] ])
// => '<li>fred</li><li>barney</li>'
// Use the internal `print` function in "evaluate" delimiters.
$ compiled = template ( ' <% print("hello " + $user)%>! ' )
$ compiled ([ ' user ' => ' barney ' ])
// => 'hello barney!'
// Use backslashes to treat delimiters as plain text.
$ compiled = template ( ' <%= " \ <%- value % \ >" %> ' )
$ compiled ([ ' value ' => ' ignored ' ])
// => '<%- value %>'
// Use the `imports` option to import functions or classes with aliases.
$ text = ' <% all($users, function($user) { %><li><%- user %></li><% })%> '
$ compiled = template( $ text , { ' imports ' : { ' _each ' : ' all ' } })
$ compiled ([ ' users ' => [ ' fred ' , ' barney ' ] ])
// => '<li>fred</li><li>barney</li>'
// Use custom template delimiters.
_:: $ templateSettings [ ' interpolate ' ] = ' {{([sS]+?)}} '
$ compiled = template ( ' hello {{ user }}! ' )
$ compiled ([ ' user ' => ' mustache ' ])
// => 'hello mustache!'
// Use the `source` property to access the compiled source of the template
template ( $ mainText )-> source ;
string
を全体として、小文字に変換します
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列は、下部のケース型の文字列を返します。
例:
<?php
use function _ toLower ;
toLower ( ' --Foo-Bar-- ' )
// => '--foo-bar--'
toLower ( ' fooBar ' )
// => 'foobar'
toLower ( ' __FOO_BAR__ ' )
// => '__foo_bar__'
string
を全体として、大文字に変換します
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列上部のケース付き文字列を返します。
例:
<?php
use function _ toUpper ;
toUpper ( ' --foo-bar-- ' )
// => '--FOO-BAR--'
toUpper ( ' fooBar ' )
// => 'FOOBAR'
toUpper ( ' __foo_bar__ ' )
// => '__FOO_BAR__'
string
からリーディングおよびトレーリングホワイトスペースまたは指定された文字を削除します。
引数:
@Param String $ string string the trim。
@Param String $は、キャラクターを充電してトリミングします。
戻る:
@return文字列トリミングされた文字列を返します。
例:
<?php
use function _ trim ;
trim ( ' abc ' )
// => 'abc'
trim ( ' -_-abc-_- ' , ' _- ' )
// => 'abc'
string
から後続の空白または指定された文字を削除します。
引数:
@Param String $ string string the trim。
@Param String $は、キャラクターを充電してトリミングします。
戻る:
@return文字列トリミングされた文字列を返します。
例:
<?php
use function _ trimEnd ;
trimEnd ( ' abc ' )
// => ' abc'
trimEnd ( ' -_-abc-_- ' , ' _- ' )
// => '-_-abc'
string
から主要な空白または指定された文字を削除します。
引数:
@Param String $ string string the trim。
@Param String $は、キャラクターを充電してトリミングします。
戻る:
@return文字列トリミングされた文字列を返します。
例:
<?php
use function _ trimStart ;
trimStart ( ' abc ' )
// => 'abc '
trimStart ( ' -_-abc-_- ' , ' _- ' )
// => 'abc-_-'
指定された最大文字列長よりも長い場合、 string
を切り捨てます。切り捨てられた文字列の最後の文字は、デフォルトで「...」になる省略文字列に置き換えられます。
長さ= 30最大文字列長。省略= '...'テキストを示す文字列は省略されています。分離器パターンを切り捨てます。
引数:
@Param String $ String string the Struncate。
@Param Array $オプションオプションオブジェクト。
戻る:
@return文字列切り替えられた文字列を返します。
例:
<?php
use function _ truncate ;
truncate ( ' hi-diddly-ho there, neighborino ' )
// => 'hi-diddly-ho there, neighbo...'
truncate ( ' hi-diddly-ho there, neighborino ' , [
' length ' => 24 ,
' separator ' => ' '
])
// => 'hi-diddly-ho there,...'
truncate ( ' hi-diddly-ho there, neighborino ' , [
' length ' => 24 ,
' separator ' => ' /,? +/ '
])
// => 'hi-diddly-ho there...'
truncate ( ' hi-diddly-ho there, neighborino ' , [
' omission ' => ' [...] '
])
// => 'hi-diddly-ho there, neig [...]'
このescape
の逆の逆は、HTMLエンティティ&
、 <
、 >
、 "
および'
対応する文字にstring
で。
引数:
@Param String $ String String to Unescape。
戻る:
@return文字列は、覆い隠されていない文字列を返します。
例:
<?php
use function _ unescape ;
unescape ( ' fred, barney, & pebbles ' )
// => 'fred, barney, & pebbles'
スペースを分離した単語として、 string
大文字に変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return stringは、上部ケースの弦を返します
例:
<?php
use function _ upperCase ;
upperCase ( ' --foo-bar ' )
// => 'FOO BAR'
upperCase ( ' fooBar ' )
// => 'FOO BAR'
upperCase ( ' __foo_bar__ ' )
// => 'FOO BAR'
string
の最初の文字を大文字に変換します。
引数:
@Param String $ STRING STRING THE STRINT。
戻る:
@return文字列変換された文字列を返します。
例:
<?php
use function _ upperFirst ;
upperFirst ( ' fred ' )
// => 'Fred'
upperFirst ( ' FRED ' )
// => 'FRED'
string
その単語の配列に分割します。
引数:
@Param String $文字列検査する文字列。
@Param String $パターンパターン単語に合わせます。
戻る:
@return配列はstring
の単語を返します。
例:
<?php
use function _ words ;
words ( ' fred, barney, & pebbles ' )
// => ['fred', 'barney', 'pebbles']
words ( ' fred, barney, & pebbles ' , ' /[^, ]+/g ' )
// => ['fred', 'barney', '&', 'pebbles']
func
呼び出し、結果またはキャッチされたエラーオブジェクトのいずれかを返します。 func
が呼び出されたときに追加の引数が提供されます。
s議論:
@Param Callable $ FUNC試行機能。
@param array <int、mixed> $は、 func
呼び出すための引数をjormsしています。
戻る:
@return(Mixed | Throwable) func
結果またはエラーオブジェクトを返します。
例:
<?php
use function _ attempt ;
// Avoid throwing errors for invalid PDO data source.
$ elements = attempt ( function () {
new PDO ( null );
});
if ( isError ( $ elements )) {
$ elements = [];
}
値をチェックして、その代わりにデフォルト値を返す必要があるかどうかを判断します。値がnanまたはnullの場合、defaultvalueは返されます。
引数:
@Param Mixed $ Value Any Value。
@param Mixed $ defaultValue値は、$ valueがnullまたはnanである場合に返信します
戻る:
@return混合返品value
。
例:
<?php
use function _ defaultTo ;
$ a = null ;
defaultTo ( $ a , " default " );
// => "default"
$ a = " x " ;
defaultTo ( $ a , " default " );
// => "x"
この方法は、受信する最初の引数を返します。
引数:
@Param Mixed $ Value Any Value。
戻る:
@return混合返品value
。
例:
<?php
use function _ identity ;
$ object = [ ' a ' => 1 ];
identity ( $ object ) === $ object ;
// => true
特定のオブジェクトのpath
で値を返す関数を作成します。
引数:
@param(array | string)$パスプロパティのパスを取得します。
戻る:
@return callableは、新しいアクセサー機能を返します。
例:
<?php
use function _ property ;
$ objects = [
[ ' a ' => [ ' b ' => 2 ] ],
[ ' a ' => [ ' b ' => 1 ] ]
];
map ( $ objects , property ( ' a.b ' ));
// => [2, 1]
map ( sortBy ( $ objects , property ([ ' a ' , ' b ' ])), ' a.b ' );
// => [1, 2]