Collections
in package
implements
IteratorAggregate
イテレータを使用したコレクション処理(LINQしたいのだ)。
実行速度ではなく、開発効率を目標としている。
Tags
Table of Contents
Interfaces
- IteratorAggregate
Properties
- $iterator : Iterator
Methods
- aggregate() : mixed
- [即時] 集計。
- all() : bool
- [即時] 全ての要素が条件を満たすか。
- any() : bool
- [即時] 要素が含まれているか。
- append() : self
- [遅延] 要素を末尾追加。
- concat() : self
- [遅延] 末尾に連結。
- count() : int
- [即時] 件数を取得。
- empty() : self
- 空のコレクション。
- first() : mixed
- [即時] 先頭要素を取得。
- firstOr() : mixed
- [即時] 先頭要素を取得、存在しない場合は指定値を返す。
- from() : self
- 配列からコレクション生成。
- getIterator() : Traversable
- last() : mixed
- [即時] 終端要素を取得。
- lastOr() : mixed
- [即時] 終端要素を取得、存在しない場合は指定値を返す。
- max() : mixed
- [即時] 最大データの取得。
- min() : mixed
- [即時] 最小データの取得。
- prepend() : self
- [遅延] 要素を先頭追加。
- range() : self
- 指定した範囲内の整数からコレクション生成。
- repeat() : self
- 繰り返されるコレクション生成。
- reverse() : self
- [遅延] 反転。
- select() : self
- [遅延] 射影。
- selectMany() : self
- [遅延] 射影-平坦化。
- single() : mixed
- [即時] 単独の要素取得。
- singleOr() : mixed
- [即時] 単独の要素取得、存在しない場合は指定値を返す。
- skip() : self
- [遅延] 先頭から指定数をバイパス。
- skipWhile() : self
- [遅延] 先頭から条件を満たす限りバイパス。
- take() : self
- [遅延] 先頭から指定された件数を返却。
- takeWhile() : self
- [遅延] 先頭から条件を満たすデータを返却。
- toArray() : array<string|int, mixed>
- 配列実体化。
- toDictionary() : Dictionary
- 辞書実体化。
- toList() : Vector
- リスト実体化。
- where() : self
- [遅延] フィルタリング
- zip() : self
- [遅延] zip
- __construct() : mixed
- 生成。
- create() : self
- イテレータから生成。
- wrap() : self
- ジェネレータから生成。
Properties
$iterator
private
Iterator
$iterator
Methods
aggregate()
[即時] 集計。
public
aggregate(callable $callback[, mixed $initial = 0 ]) : mixed
Parameters
- $callback : callable
- $initial : mixed = 0
Tags
all()
[即時] 全ての要素が条件を満たすか。
public
all(callable $callback) : bool
Parameters
- $callback : callable
Tags
Return values
boolany()
[即時] 要素が含まれているか。
public
any([callable|null $callback = null ]) : bool
Parameters
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
Return values
boolappend()
[遅延] 要素を末尾追加。
public
append(mixed $value) : self
Parameters
- $value : mixed
Tags
Return values
selfconcat()
[遅延] 末尾に連結。
public
concat(Traversable|array<string|int, mixed>|callable $sequence) : self
Parameters
- $sequence : Traversable|array<string|int, mixed>|callable
Tags
Return values
selfcount()
[即時] 件数を取得。
public
count([callable|null $callback = null ]) : int
Parameters
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
Return values
intempty()
空のコレクション。
public
static empty() : self
Tags
Return values
selffirst()
[即時] 先頭要素を取得。
public
first([callable|null $callback = null ]) : mixed
Parameters
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
firstOr()
[即時] 先頭要素を取得、存在しない場合は指定値を返す。
public
firstOr(mixed $notFound[, callable|null $callback = null ]) : mixed
Parameters
- $notFound : mixed
-
存在しない場合の戻り値。
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
from()
配列からコレクション生成。
public
static from(Traversable|array<string|int, mixed>|callable $sequence) : self
Parameters
- $sequence : Traversable|array<string|int, mixed>|callable
Tags
Return values
selfgetIterator()
public
getIterator() : Traversable
Tags
Return values
Traversablelast()
[即時] 終端要素を取得。
public
last([callable|null $callback = null ]) : mixed
Parameters
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
lastOr()
[即時] 終端要素を取得、存在しない場合は指定値を返す。
public
lastOr(mixed $notFound[, callable|null $callback = null ]) : mixed
Parameters
- $notFound : mixed
-
存在しない場合の戻り値。
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
max()
[即時] 最大データの取得。
public
max([callable|null $callback = null ]) : mixed
Parameters
- $callback : callable|null = null
Tags
min()
[即時] 最小データの取得。
public
min([callable|null $callback = null ]) : mixed
Parameters
- $callback : callable|null = null
Tags
prepend()
[遅延] 要素を先頭追加。
public
prepend(mixed $value) : self
Parameters
- $value : mixed
Tags
Return values
selfrange()
指定した範囲内の整数からコレクション生成。
public
static range(int $start, int $count) : self
Parameters
- $start : int
-
開始。
- $count : int
-
件数。
Tags
Return values
selfrepeat()
繰り返されるコレクション生成。
public
static repeat(mixed $value, int $count) : self
Parameters
- $value : mixed
-
値。
- $count : int
-
件数。
Tags
Return values
selfreverse()
[遅延] 反転。
public
reverse() : self
Tags
Return values
selfselect()
[遅延] 射影。
public
select(callable $callback) : self
Parameters
- $callback : callable
Tags
Return values
selfselectMany()
[遅延] 射影-平坦化。
public
selectMany(callable $callback) : self
Parameters
- $callback : callable
Tags
Return values
selfsingle()
[即時] 単独の要素取得。
public
single([callable|null $callback = null ]) : mixed
Parameters
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
singleOr()
[即時] 単独の要素取得、存在しない場合は指定値を返す。
public
singleOr(mixed $notFound[, callable|null $callback = null ]) : mixed
Parameters
- $notFound : mixed
-
存在しない場合の戻り値。
- $callback : callable|null = null
-
非nullの場合条件指定。
Tags
skip()
[遅延] 先頭から指定数をバイパス。
public
skip(int $skipCount) : self
Parameters
- $skipCount : int
Tags
Return values
selfskipWhile()
[遅延] 先頭から条件を満たす限りバイパス。
public
skipWhile(callable $callback) : self
Parameters
- $callback : callable
Tags
Return values
selftake()
[遅延] 先頭から指定された件数を返却。
public
take(int $takeCount) : self
Parameters
- $takeCount : int
Tags
Return values
selftakeWhile()
[遅延] 先頭から条件を満たすデータを返却。
public
takeWhile(callable $callback) : self
Parameters
- $callback : callable
Tags
Return values
selftoArray()
配列実体化。
public
toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>toDictionary()
辞書実体化。
public
toDictionary(callable $keyFactory, callable $valueFactory[, class-string|TypeUtility::TYPE_* $type = TypeUtility::TYPE_NULL ]) : Dictionary
Parameters
- $keyFactory : callable
-
第1引数:値, 第1引数:キー(文字列変換済み), 戻り値:キー(文字列)。
- $valueFactory : callable
-
第1引数:値, 第1引数:キー(文字列変換済み), 戻り値:値。
- $type : class-string|TypeUtility::TYPE_* = TypeUtility::TYPE_NULL
Tags
Return values
DictionarytoList()
リスト実体化。
public
toList([class-string|TypeUtility::TYPE_* $type = TypeUtility::TYPE_NULL ]) : Vector
Enumerable.ToList<TSource>
的な。
Parameters
- $type : class-string|TypeUtility::TYPE_* = TypeUtility::TYPE_NULL
Tags
Return values
Vectorwhere()
[遅延] フィルタリング
public
where(callable $callback) : self
Parameters
- $callback : callable
-
値, キー: 条件を満たすか
Tags
Return values
selfzip()
[遅延] zip
public
zip(Traversable|array<string|int, mixed>|callable $sequence, callable $callback) : self
Parameters
- $sequence : Traversable|array<string|int, mixed>|callable
- $callback : callable
Tags
Return values
self__construct()
生成。
private
__construct(Iterator $iterator) : mixed
Parameters
- $iterator : Iterator
Tags
create()
イテレータから生成。
private
static create(Iterator $iterator) : self
Parameters
- $iterator : Iterator
Tags
Return values
selfwrap()
ジェネレータから生成。
private
static wrap(callable $generatorFactory) : self
Parameters
- $generatorFactory : callable