0 follower

Final Class Yiisoft\HttpMiddleware\HttpCache\ETagProvider\PredefinedETagProvider

All Classes | Methods

Inheritance	Yiisoft\HttpMiddleware\HttpCache\ETagProvider\PredefinedETagProvider
Implements	Yiisoft\HttpMiddleware\HttpCache\ETagProvider\ETagProviderInterface

Provides Yiisoft\HttpMiddleware\HttpCache\ETag from a predefined collection. Useful for testing purposes.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\HttpMiddleware\HttpCache\ETagProvider\PredefinedETagProvider
get()		Yiisoft\HttpMiddleware\HttpCache\ETagProvider\PredefinedETagProvider

Method Details

Hide inherited methods

__construct() public method

public __construct( iterable $tags ): mixed
$tags	iterable	Predefined Yiisoft\HttpMiddleware\HttpCache\ETag to be returned by the provider.

Source code

                public function __construct(iterable $tags)
{
    $this->iterator = $this->createIterator($tags);
}

get() public method

public get( \Psr\Http\Message\ServerRequestInterface $request ): Yiisoft\HttpMiddleware\HttpCache\ETag
$request	\Psr\Http\Message\ServerRequestInterface

Source code

                public function get(ServerRequestInterface $request): ETag
{
    if (!$this->iterator->valid()) {
        throw new OutOfBoundsException('No more tags available.');
    }
    /** @var ETag $eTag */
    $eTag = $this->iterator->current();
    $this->iterator->next();
    return $eTag;
}