0 follower

Interface Yiisoft\Yii\Debug\Collector\SummaryCollectorInterface

All Classes | Methods
ExtendsYiisoft\Yii\Debug\Collector\CollectorInterface
Implemented byYiisoft\Yii\Debug\Collector\Console\CommandCollector, Yiisoft\Yii\Debug\Collector\Console\ConsoleAppInfoCollector, Yiisoft\Yii\Debug\Collector\EventCollector, Yiisoft\Yii\Debug\Collector\ExceptionCollector, Yiisoft\Yii\Debug\Collector\HttpClientCollector, Yiisoft\Yii\Debug\Collector\LogCollector, Yiisoft\Yii\Debug\Collector\ServiceCollector, Yiisoft\Yii\Debug\Collector\Stream\FilesystemStreamCollector, Yiisoft\Yii\Debug\Collector\Stream\HttpStreamCollector, Yiisoft\Yii\Debug\Collector\VarDumperCollector, Yiisoft\Yii\Debug\Collector\Web\RequestCollector, Yiisoft\Yii\Debug\Collector\Web\WebAppInfoCollector

Summary data collector responsibility is to collect summary data for a collector.

Summary is used to display a list of previous requests and select one to display full info. Its data set is specific to the list and is reduced compared to full data collected in {@see \Yiisoft\Yii\Debug\Collector\CollectorInterface}.

Public Methods

Hide inherited methods

Method Description Defined By
getCollected() Yiisoft\Yii\Debug\Collector\CollectorInterface
getName() Yiisoft\Yii\Debug\Collector\CollectorInterface
getSummary() Yiisoft\Yii\Debug\Collector\SummaryCollectorInterface
shutdown() Called once at application shutdown. Yiisoft\Yii\Debug\Collector\CollectorInterface
startup() Called once at application startup. Yiisoft\Yii\Debug\Collector\CollectorInterface

Method Details

Hide inherited methods

getCollected() public abstract method

Defined in: Yiisoft\Yii\Debug\Collector\CollectorInterface::getCollected()

public abstract array getCollected ( )
return array

Data collected.

 

                public function getCollected(): array;
getName() public abstract method

Defined in: Yiisoft\Yii\Debug\Collector\CollectorInterface::getName()

public abstract string getName ( )
return string

Collector's name.

 

                public function getName(): string;
getSummary() public abstract method

public abstract array getSummary ( )
return array

Summary payload. Keys may cross with any other summary collectors.

 

                public function getSummary(): array;
shutdown() public abstract method

Defined in: Yiisoft\Yii\Debug\Collector\CollectorInterface::shutdown()

Called once at application shutdown.

Cleanup could be done here. Implementation must be idempotent.

public abstract void shutdown ( )

                public function shutdown(): void;
startup() public abstract method

Defined in: Yiisoft\Yii\Debug\Collector\CollectorInterface::startup()

Called once at application startup.

Any initialization could be done here.

public abstract void startup ( )

                public function startup(): void;