PeServer

Arr
in package

配列共通処理。

遅延処理が必要な場合 Collections を参照のこと。

Tags
see
Collections

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
phpstan-param

array<array-key,mixed> $haystack

phpstan-param

array-key $key

see
https://www.php.net/manual/function.array-key-exists.php
Return values
bool

containsValue()

配列に指定要素が存在するか。

public static containsValue(array<string|int, mixed> $haystack, mixed $needle) : bool

array_search ラッパー。

Parameters
$haystack : array<string|int, mixed>

対象配列。

$needle : mixed

検索データ。

Tags
template

TValue

phpstan-param

TValue[] $haystack

phpstan-param

TValue $needle

see
https://www.php.net/manual/function.array-search.php
Return values
bool

flip()

`array_flip` ラッパー。

public static flip(array<string|int, mixed> $input) : array<string|int, mixed>
Parameters
$input : array<string|int, mixed>

対象配列。

Tags
template

TKey of array-key

template

TValue

phpstan-param

array<TKey,TValue> $input

phpstan-param

array<TValue,TKey> $input

throws
ArgumentException
see
https://www.php.net/manual/function.array-flip.php
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
phpstan-return

non-negative-int

see
https://www.php.net/manual/function.count.php
Return values
int

件数。

getKeys()

対象配列のキー一覧を取得。

public static getKeys(array<int|string, mixed> $array) : array<string|int, int|string>

array_keys ラッパー。

Parameters
$array : array<int|string, mixed>

対象配列。

Tags
phpstan-param

array<array-key,mixed> $array

phpstan-return

list

see
https://www.php.net/manual/function.array-keys.php
Return values
array<string|int, int|string>

getRandomKeys()

キー項目をランダム取得。

public static getRandomKeys(array<string|int, mixed> $array, int $count) : array<string|int, string|int>
Parameters
$array : array<string|int, mixed>

対象配列。

$count : int

取得数。

Tags
phpstan-param

non-empty-array $array

phpstan-param

positive-int $count

phpstan-return

list

throws
ArgumentException
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
template

TValue

phpstan-param

array<array-key,TValue> $array

phpstan-return

list<TValue>

see
https://www.php.net/manual/function.array-values.php
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
template

TValue

phpstan-param

array<array-key,TValue> $haystack

phpstan-param

TValue $needle

see
https://www.php.net/manual/function.in-array.php
Return values
bool

isList()

`array_is_list` ラッパー。

public static isList(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>

対象配列。

Tags
template

TValue

phpstan-param

array<TValue> $array 対象配列。

see
https://www.php.net/manual/function.array-is-list.php#127044
phpstan-assert-if-true

list<TValue> $array

Return values
bool

isListImpl()

`isList` 実装。

public static isListImpl(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>

対象配列。

Tags
template

TValue

phpstan-param

array<TValue> $array 対象配列。

phpstan-assert-if-true

list<TValue> $array

Return values
bool

isNullOrEmpty()

配列が `null` か空か。

public static isNullOrEmpty(array<string|int, mixed>|null $array) : bool
Parameters
$array : array<string|int, mixed>|null

対象配列。

Tags
template

TValue

phpstan-param

array<TValue>|null $array 対象配列。

phpstan-assert-if-false

non-empty-array<TValue> $array

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
template

TValue

template

TResult

phpstan-param

array<array-key,TValue> $input

phpstan-param

callable(TValue,array-key): TResult $callback

phpstan-return

array<array-key,TResult>

Return values
array<string|int, mixed>

range()

指定した範囲内の整数から配列生成。

public static range(int $start, int $count) : self

PHP の range とは指定方法が違うことに注意。

Parameters
$start : int

開始。

$count : int

件数。

Tags
phpstan-param

non-negative-int $count

phpstan-return

list

Return values
self

repeat()

繰り返される配列を生成。

public static repeat(mixed $value, int $count) : self

array_fill ラッパー。

Parameters
$value : mixed

値。

$count : int

件数。

Tags
template

TRepeatValue

phpstan-param

TRepeatValue $value

phpstan-param

non-negative-int $count

phpstan-return

list<TRepeatValue>

see
https://www.php.net/manual/function.array-fill.php
Return values
self

replace()

`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
see
https://www.php.net/manual/function.array-replace-recursive.php
see
https://www.php.net/manual/function.array-replace.php
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
template

TKey of array-key

template

TValue

phpstan-param

array<TKey,TValue> $input

phpstan-return

array<TKey,TValue>

see
https://www.php.net/manual/function.array-reverse.php
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
template

TValue

phpstan-param

array<array-key,TValue> $array

phpstan-param

callable(array-key,array-key):int $callback

phpstan-return

array<array-key,TValue>

see
https://www.php.net/manual/function.usort.php
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
template

TValue

phpstan-param

TValue[] $array

phpstan-param

callable(TValue,TValue):int $callback

phpstan-return

TValue[]

see
https://www.php.net/manual/function.usort.php
see
https://www.php.net/manual/function.uasort.php
see
https://www.php.net/manual/function.asort.php
see
https://www.php.net/manual/function.arsort.php
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
template

TValue

phpstan-param

TValue[] $array

phpstan-return

TValue[]

see
https://www.php.net/manual/function.natsort.php
see
https://www.php.net/manual/function.natcasesort.php
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
template

TKey of array-key

template

TValue

phpstan-param

array<TKey,TValue> $array

see
https://www.php.net/manual/function.array-unique.php
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
template

TValue

phpstan-param

array<array-key,TValue>|null $array

phpstan-param

array-key $key

phpstan-param

TValue $result

Return values
bool

値が存在したか。


        
On this page

Search results