0

Interface Yiisoft\Profiler\ProfilerInterface

All Classes | Methods
Implemented byYiisoft\Profiler\Profiler

ProfilerInterface describes a profiler instance.

Public Methods

Hide inherited methods

Method Description Defined By
begin() Marks the beginning of a code block for profiling. Yiisoft\Profiler\ProfilerInterface
end() Marks the end of a code block for profiling. Yiisoft\Profiler\ProfilerInterface
findMessages() Find messages with a given token. Yiisoft\Profiler\ProfilerInterface
flush() Flushes profiling messages from memory to actual storage. Yiisoft\Profiler\ProfilerInterface

Method Details

Hide inherited methods

begin() public abstract method

Marks the beginning of a code block for profiling.

This has to be matched with a call to {@see \Yiisoft\Profiler\end()} with the same category name. The begin- and end- calls must also be properly nested.

public abstract void begin ( string $token, array $context = [] )
$token string

Token for the code block.
$context array

The context data of this profile block.

 

                public function begin(string $token, array $context = []): void;
end() public abstract method

Marks the end of a code block for profiling.

This has to be matched with a previous call to {@see \Yiisoft\Profiler\begin()} with the same category name.

public abstract void end ( string $token, array $context = [] )
$token string

Token for the code block.
$context array

The context data of this profile block.

{@see \Yiisoft\Profiler\begin()}

 

                public function end(string $token, array $context = []): void;
findMessages() public abstract method

Find messages with a given token.

public abstract Yiisoft\Profiler\Message[] findMessages ( string $token )
$token string

Code block token.
return Yiisoft\Profiler\Message[]

The messages profiler.

 

                public function findMessages(string $token): array;
flush() public abstract method

Flushes profiling messages from memory to actual storage.

public abstract void flush ( )

                public function flush(): void;