\Drupal\strata\Capture\Classifier DiscoveryReport

What one keyspace discovery pass found.

The number to read is how much sits under Classification::UNCLASSIFIED. Everything there is being captured because nothing recognised it, which is the safe default and also the expensive one, so it is the list an administrator works through.

Summary

Methods
Properties
Constants
__construct
isClean
couldLook
patternsAt
keysAt
bytesAt
summary
jsonSerialize
sources
keys
patterns
totals
problems
seconds
No public constants found
No protected methods found
No protected properties found
No protected constants found
No private methods found
No private properties found
No private constants found

Properties

$sources

$sources : int

Type

int

$keys

$keys : int

Type

int

$patterns

$patterns : int

Type

int

$totals

$totals : array

Type

array<string|int, mixed>

$problems

$problems : array

Type

array<string|int, mixed>

$seconds

$seconds : float

Type

float

Methods

__construct()

__construct(int  $sources = 0, int  $keys = 0, int  $patterns = 0, array  $totals = [], list  $problems = [], float  $seconds = 0.0) : mixed

Constructs a report.

Parameters

int $sources

How many sources were asked.

int $keys

Keys seen across all of them.

int $patterns

Distinct patterns those keys fell into.

array $totals

Classification value keyed to its totals, as the registry reports them.

list $problems

One line per source that could not be read.

float $seconds

How long the pass took.

Returns

mixed —

isClean()

isClean() : bool

Whether every source was read.

Returns

bool —

TRUE when nothing failed.

couldLook()

couldLook() : bool

Whether anything could be discovered at all.

A pass with no sources is not a clean pass over an empty keyspace; it is a pass that could not look, and reporting the two the same way is how an unmonitored keyspace looks monitored.

Returns

bool —

TRUE when at least one source was registered.

patternsAt()

patternsAt(\Drupal\strata\Capture\Classifier\Classification  $classification) : int

Patterns sitting at one classification.

Parameters

\Drupal\strata\Capture\Classifier\Classification $classification

The classification.

Returns

int —

The count.

keysAt()

keysAt(\Drupal\strata\Capture\Classifier\Classification  $classification) : int

Keys sitting at one classification.

Parameters

\Drupal\strata\Capture\Classifier\Classification $classification

The classification.

Returns

int —

The count.

bytesAt()

bytesAt(\Drupal\strata\Capture\Classifier\Classification  $classification) : int

Bytes sitting at one classification.

Parameters

\Drupal\strata\Capture\Classifier\Classification $classification

The classification.

Returns

int —

The byte total.

summary()

summary() : string

A one-line summary for a log entry or a command's output.

Returns

string —

The summary.

jsonSerialize()

jsonSerialize() : array<string,mixed>

{@inheritdoc}

Returns

array

The report as a plain array.