Arr
in package
配列共通処理。
遅延処理が必要な場合 Collections
を参照のこと。
Tags
Table of Contents
Methods
- containsKey() : bool
- 配列に該当キーは存在するか。
- containsValue() : bool
- 配列に指定要素が存在するか。
- flip() : array<string|int, mixed>
- `array_flip` ラッパー。
- getCount() : int
- 配列の件数を取得。
- getFirstKey() : int|string
- `array_key_first` ラッパー。
- getKeys() : array<string|int, int|string>
- 対象配列のキー一覧を取得。
- getLastKey() : int|string
- `array_key_last` ラッパー。
- getRandomKeys() : array<string|int, string|int>
- キー項目をランダム取得。
- getValues() : array<string|int, mixed>
- 対象配列の値一覧を取得。
- in() : bool
- `in_array` ラッパー。
- isList() : bool
- `array_is_list` ラッパー。
- isListImpl() : bool
- `isList` 実装。
- isNullOrEmpty() : bool
- 配列が `null` か空か。
- map() : array<string|int, mixed>
- `array_map` 的なことを行う非ラッパー処理。
- range() : self
- 指定した範囲内の整数から配列生成。
- repeat() : self
- 繰り返される配列を生成。
- replace() : array<string|int, mixed>
- `array_replace(_recursive)` ラッパー。
- reverse() : array<string|int, mixed>
- `reverse` ラッパー。
- sortByKey() : array<string|int, mixed>
- キーによる単純ソート。
- sortByValue() : array<string|int, mixed>
- 値による単純ソート。
- sortCallbackByKey() : array<string|int, mixed>
- キーによるユーザー定義ソート。
- sortCallbackByValue() : array<string|int, mixed>
- 値によるユーザー定義ソート。
- sortNaturalByValue() : array<string|int, mixed>
- 値による自然昇順ソート。
- toUnique() : array<string|int, mixed>
- `array_unique` ラッパー。
- tryGet() : bool
- 配列から値を取得する。
Methods
containsKey()
配列に該当キーは存在するか。
public
static containsKey(array<string|int, mixed> $haystack, int|string $key) : bool
array_key_exists
ラッパー。
Parameters
- $haystack : array<string|int, mixed>
-
対象配列。
- $key : int|string
-
キー。
Tags
Return values
boolcontainsValue()
配列に指定要素が存在するか。
public
static containsValue(array<string|int, mixed> $haystack, mixed $needle) : bool
array_search
ラッパー。
Parameters
- $haystack : array<string|int, mixed>
-
対象配列。
- $needle : mixed
-
検索データ。
Tags
Return values
boolflip()
`array_flip` ラッパー。
public
static flip(array<string|int, mixed> $input) : array<string|int, mixed>
Parameters
- $input : array<string|int, mixed>
-
対象配列。
Tags
Return values
array<string|int, mixed>getCount()
配列の件数を取得。
public
static getCount(array<string|int, mixed>|Countable|null $array) : int
Parameters
- $array : array<string|int, mixed>|Countable|null
-
対象配列。
Tags
Return values
int —件数。
getFirstKey()
`array_key_first` ラッパー。
public
static getFirstKey(array<string|int, mixed> $array) : int|string
Parameters
- $array : array<string|int, mixed>
-
対象配列。
Tags
Return values
int|stringgetKeys()
対象配列のキー一覧を取得。
public
static getKeys(array<int|string, mixed> $array) : array<string|int, int|string>
array_keys
ラッパー。
Parameters
- $array : array<int|string, mixed>
-
対象配列。
Tags
Return values
array<string|int, int|string>getLastKey()
`array_key_last` ラッパー。
public
static getLastKey(array<string|int, mixed> $array) : int|string
Parameters
- $array : array<string|int, mixed>
-
対象配列。
Tags
Return values
int|stringgetRandomKeys()
キー項目をランダム取得。
public
static getRandomKeys(array<string|int, mixed> $array, int $count) : array<string|int, string|int>
Parameters
- $array : array<string|int, mixed>
-
対象配列。
- $count : int
-
取得数。
Tags
Return values
array<string|int, string|int>getValues()
対象配列の値一覧を取得。
public
static getValues(array<string|int, mixed> $array) : array<string|int, mixed>
array_values
ラッパー。
Parameters
- $array : array<string|int, mixed>
-
対象配列。
Tags
Return values
array<string|int, mixed>in()
`in_array` ラッパー。
public
static in(array<int|string, mixed> $haystack, mixed $needle) : bool
Parameters
- $haystack : array<int|string, mixed>
-
対象配列。
- $needle : mixed
Tags
Return values
boolisList()
`array_is_list` ラッパー。
public
static isList(array<string|int, mixed> $array) : bool
Parameters
- $array : array<string|int, mixed>
-
対象配列。
Tags
Return values
boolisListImpl()
`isList` 実装。
public
static isListImpl(array<string|int, mixed> $array) : bool
Parameters
- $array : array<string|int, mixed>
-
対象配列。
Tags
Return values
boolisNullOrEmpty()
配列が `null` か空か。
public
static isNullOrEmpty(array<string|int, mixed>|null $array) : bool
Parameters
- $array : array<string|int, mixed>|null
-
対象配列。
Tags
Return values
bool —null
か空の場合に真。
map()
`array_map` 的なことを行う非ラッパー処理。
public
static map(array<string|int, mixed> $input, callable $callback) : array<string|int, mixed>
array_map
がもうなんか順序もコールバック引数も何もかも怖い。
Parameters
- $input : array<string|int, mixed>
-
対象配列。
- $callback : callable
Tags
Return values
array<string|int, mixed>range()
指定した範囲内の整数から配列生成。
public
static range(int $start, int $count) : self
PHP の range
とは指定方法が違うことに注意。
Parameters
- $start : int
-
開始。
- $count : int
-
件数。
Tags
Return values
selfrepeat()
繰り返される配列を生成。
public
static repeat(mixed $value, int $count) : self
array_fill
ラッパー。
Parameters
- $value : mixed
-
値。
- $count : int
-
件数。
Tags
Return values
selfreplace()
`array_replace(_recursive)` ラッパー。
public
static replace(array<string|int, mixed> $base, array<string|int, mixed> $overwrite[, bool $recursive = true ]) : array<string|int, mixed>
Parameters
- $base : array<string|int, mixed>
-
元になる配列。
- $overwrite : array<string|int, mixed>
-
上書きする配列。
- $recursive : bool = true
-
再帰的置き換えを行うか(
_recursive
呼び出し)。
Tags
Return values
array<string|int, mixed>reverse()
`reverse` ラッパー。
public
static reverse(array<string|int, mixed> $input) : array<string|int, mixed>
Parameters
- $input : array<string|int, mixed>
-
対象配列。
Tags
Return values
array<string|int, mixed>sortByKey()
キーによる単純ソート。
public
static sortByKey(array<string|int, mixed> $array, OrderBy $orderBy) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $orderBy : OrderBy
Tags
Return values
array<string|int, mixed>sortByValue()
値による単純ソート。
public
static sortByValue(array<string|int, mixed> $array, OrderBy $orderBy) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $orderBy : OrderBy
Tags
Return values
array<string|int, mixed>sortCallbackByKey()
キーによるユーザー定義ソート。
public
static sortCallbackByKey(array<string|int, mixed> $array, callable $callback) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $callback : callable
Tags
Return values
array<string|int, mixed>sortCallbackByValue()
値によるユーザー定義ソート。
public
static sortCallbackByValue(array<string|int, mixed> $array, callable $callback) : array<string|int, mixed>
asort
とかもこいつでやってくれ。
Parameters
- $array : array<string|int, mixed>
- $callback : callable
Tags
Return values
array<string|int, mixed>sortNaturalByValue()
値による自然昇順ソート。
public
static sortNaturalByValue(array<string|int, mixed> $array, bool $ignoreCase) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $ignoreCase : bool
-
大文字小文字を無視するか。
Tags
Return values
array<string|int, mixed>toUnique()
`array_unique` ラッパー。
public
static toUnique(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
-
対象配列。
Tags
Return values
array<string|int, mixed>tryGet()
配列から値を取得する。
public
static tryGet(array<int|string, mixed>|null $array, int|string $key, mixed &$result) : bool
Parameters
- $array : array<int|string, mixed>|null
-
対象配列。
- $key : int|string
-
キー。
- $result : mixed
-
値を格納する変数。
Tags
Return values
bool —値が存在したか。