classCandidateCollection

packages/deriver/src/Deriver/Candidate/CandidateCollection.php:23

final class CandidateCollection
    implements ArrayAccess<int, Candidate>, IteratorAggregate<int, Candidate>, Countable

Public API: explicitly declared with @visibility public.

The read-only candidate set for one observation.

Counting an empty candidate setdoctest

(new \Deriver\Deriver\Candidate\CandidateCollection([], new \Deriver\Deriver\Candidate\ResultRef('r')))->count() // => 0

Properties§

public ResultRef $reference

source §

public Statistics $statistics = new \Deriver\Deriver\Candidate\Statistics()

source §

public bool $interrupted = false

source §

Methods§

public function __construct(
    private list<Candidate> $candidates,
    public ResultRef $reference,
    public Statistics $statistics = new \Deriver\Deriver\Candidate\Statistics(),
    public bool $interrupted = false,
)

source §

Parameters

`$candidates`	`list<Candidate>`
`$reference`	`ResultRef`
`$statistics`	`Statistics`
`$interrupted`	`bool`

Calls 1

new Statistics line 31

public function offsetExists(mixed $offset): bool

source §

Tests whether an integer offset identifies a candidate.

Parameters

$offset mixed Offset supplied through ArrayAccess

Returns

bool

Calls 1

function-call is_int line 42

public function offsetGet(mixed $offset): Candidate

source §

Returns a candidate by its zero-based integer offset.

Parameters

$offset mixed Offset supplied through ArrayAccess

Returns

Candidate

Throws

OutOfBoundsException If the offset is not an integer or has no candidate

Calls 2

function-call is_int line 52
new OutOfBoundsException line 53

public function offsetSet(mixed $offset, mixed $value): void

source §

Parameters

`$offset`	`mixed`
`$value`	`mixed`

Throws

RuntimeException Candidate collections cannot be changed

Calls 1

new RuntimeException line 63

public function offsetUnset(mixed $offset): void

source §

Parameters

$offset mixed

Throws

RuntimeException Candidate collections cannot be changed

Calls 1

new RuntimeException line 71

public function count(): int

source §

Returns the number of concrete and partial candidate records.

Returns

int

Calls 1

function-call count line 79

public function getIterator(): ArrayIterator<int, Candidate>

source §

Returns

ArrayIterator<int, Candidate>

Calls 1

new ArrayIterator line 89

public function forCaller(string $caller): self

source §

Filters derivations by a caller without choosing between remaining values.

Parameters

$caller string

Returns

self

Calls 3

function-call array_values line 101
function-call array_filter line 101
new self line 106

Private surface 1§

Implementation details, listed for orientation only.

private list<Candidate> $candidates

Test cases 11§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 1

CandidateCollectionTest::testOffsetGetRejectsAnEmptyCollection calls

Other tests reaching this symbol 10

Relations§

Instantiated in 1

new Deriver\Deriver\Publication\CandidateCollector::collect() packages/deriver/src/Deriver/Publication/CandidateCollector.php:63

Type declarations 6