ArrayOperation
in package
配列の操作を提供するクラスです。
Table of Contents
Constants
- RETURN_CONDITION_ELEMENT = 'element'
- RETURN_CONDITION_KEY = 'key'
- RETURN_CONDITION_VALUE = 'value'
- SEARCH_CONDITION_ELEMENT = 'element'
- SEARCH_CONDITION_KEY = 'key'
- SEARCH_CONDITION_VALUE = 'value'
Properties
- $arrayIterator : ArrayIterator<int|string, mixed>
Methods
- __construct() : mixed
- 新しいArrayOperationインスタンスを生成します。
- filter() : ArrayOperation
- 指定した条件に一致する要素を抽出します
- filterByElement() : ArrayOperation
- 指定した要素に一致する要素を抽出します
- filterByKey() : ArrayOperation
- 指定したkeyに一致する要素を抽出します
- filterByValue() : ArrayOperation
- 指定したvalueに一致する要素を抽出します
- get() : array<string|int, mixed>
- 指定した条件に一致する要素を取得します
- getElements() : array<string|int, mixed>
- 配列の要素を取得します
- getFirst() : array<string|int, mixed>
- 配列の先頭要素を取得します
- getKeys() : array<int, mixed>
- 配列のキーを取得します
- getLast() : array<string|int, mixed>
- 配列の末尾要素を取得します
- getValues() : array<int, mixed>
- 配列の値を取得します
- set() : ArrayOperation
- 新しいArrayOperationインスタンスを生成します。
Constants
RETURN_CONDITION_ELEMENT
public
mixed
RETURN_CONDITION_ELEMENT
= 'element'
RETURN_CONDITION_KEY
public
mixed
RETURN_CONDITION_KEY
= 'key'
RETURN_CONDITION_VALUE
public
mixed
RETURN_CONDITION_VALUE
= 'value'
SEARCH_CONDITION_ELEMENT
public
mixed
SEARCH_CONDITION_ELEMENT
= 'element'
SEARCH_CONDITION_KEY
public
mixed
SEARCH_CONDITION_KEY
= 'key'
SEARCH_CONDITION_VALUE
public
mixed
SEARCH_CONDITION_VALUE
= 'value'
Properties
$arrayIterator
private
ArrayIterator<int|string, mixed>
$arrayIterator
イテレータクラスのインスタンス
Methods
__construct()
新しいArrayOperationインスタンスを生成します。
public
__construct(ArrayIterator<int|string, mixed> $arrayIterator) : mixed
Parameters
- $arrayIterator : ArrayIterator<int|string, mixed>
-
イテレータクラスのインスタンスを渡します
filter()
指定した条件に一致する要素を抽出します
public
filter(array<string|int, mixed> $needle[, string $searchCondition = self::SEARCH_CONDITION_ELEMENT ]) : ArrayOperation
Parameters
- $needle : array<string|int, mixed>
- $searchCondition : string = self::SEARCH_CONDITION_ELEMENT
-
検索条件を指定します
Return values
ArrayOperationfilterByElement()
指定した要素に一致する要素を抽出します
public
filterByElement(array<int, array<string|int, mixed>> $elements) : ArrayOperation
Parameters
- $elements : array<int, array<string|int, mixed>>
-
検索対象の要素を指定します
Return values
ArrayOperationfilterByKey()
指定したkeyに一致する要素を抽出します
public
filterByKey(string|int ...$key) : ArrayOperation
Parameters
- $key : string|int
-
検索対象のkeyを指定します
Return values
ArrayOperationfilterByValue()
指定したvalueに一致する要素を抽出します
public
filterByValue(mixed ...$value) : ArrayOperation
Parameters
- $value : mixed
-
検索対象のvalueを指定します
Return values
ArrayOperationget()
指定した条件に一致する要素を取得します
public
get([string $returnCondition = self::RETURN_CONDITION_ELEMENT ]) : array<string|int, mixed>
Parameters
- $returnCondition : string = self::RETURN_CONDITION_ELEMENT
-
取得条件を指定します
Return values
array<string|int, mixed>getElements()
配列の要素を取得します
public
getElements() : array<string|int, mixed>
Return values
array<string|int, mixed>getFirst()
配列の先頭要素を取得します
public
getFirst([string $searchCondition = self::SEARCH_CONDITION_ELEMENT ]) : array<string|int, mixed>
Parameters
- $searchCondition : string = self::SEARCH_CONDITION_ELEMENT
-
検索条件を指定します
Return values
array<string|int, mixed>getKeys()
配列のキーを取得します
public
getKeys() : array<int, mixed>
Return values
array<int, mixed> —配列のキーを返します
getLast()
配列の末尾要素を取得します
public
getLast([string $searchCondition = self::SEARCH_CONDITION_ELEMENT ]) : array<string|int, mixed>
Parameters
- $searchCondition : string = self::SEARCH_CONDITION_ELEMENT
-
検索条件を指定します
Return values
array<string|int, mixed>getValues()
配列の値を取得します
public
getValues() : array<int, mixed>
Return values
array<int, mixed> —配列の値を返します
set()
新しいArrayOperationインスタンスを生成します。
public
static set(array<string|int, mixed> $value) : ArrayOperation
Parameters
- $value : array<string|int, mixed>