0 follower

Trait Yiisoft\Yii\DataView\Pagination\PaginationContextTrait

All Classes | Methods

Implemented by	Yiisoft\Yii\DataView\Pagination\KeysetPagination, Yiisoft\Yii\DataView\Pagination\OffsetPagination

Trait providing context management functionality for pagination widgets.

Public Methods

Hide inherited methods

Method	Description	Defined By
context()	Creates a new instance with the specified pagination context.	Yiisoft\Yii\DataView\Pagination\PaginationContextTrait

Protected Methods

Hide inherited methods

Method	Description	Defined By
getContext()	Gets the current pagination context.	Yiisoft\Yii\DataView\Pagination\PaginationContextTrait

Method Details

Hide inherited methods

context() public method

Creates a new instance with the specified pagination context.

public context( Yiisoft\Yii\DataView\Pagination\PaginationContext $context ): Yiisoft\Yii\DataView\Pagination\PaginationContextTrait
$context	Yiisoft\Yii\DataView\Pagination\PaginationContext	The pagination context to use.
return	Yiisoft\Yii\DataView\Pagination\PaginationContextTrait	New instance with the specified context.

Source code

                final public function context(PaginationContext $context): static
{
    $new = clone $this;
    $new->context = $context;
    return $new;
}

getContext() protected method

Gets the current pagination context.

protected getContext( ): Yiisoft\Yii\DataView\Pagination\PaginationContext
return	Yiisoft\Yii\DataView\Pagination\PaginationContext	The current pagination context.
throws	LogicException	If the context has not been set.

Source code

                final protected function getContext(): PaginationContext
{
    if ($this->context === null) {
        throw new LogicException('Context is not set.');
    }
    return $this->context;
}