Interface Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface
| Extends | Stringable |
|---|---|
| Implemented by | Yiisoft\Yii\DataView\Pagination\KeysetPagination, Yiisoft\Yii\DataView\Pagination\OffsetPagination |
Interface for widgets that render pagination controls.
See also:
- Yiisoft\Yii\DataView\Pagination\KeysetPagination A keyset-based pagination implementation.
- Yiisoft\Yii\DataView\Pagination\OffsetPagination An offset-based pagination implementation.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| context() | Creates a new instance with the specified pagination context. | Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface |
| paginator() | Creates a new instance with the specified paginator. | Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface |
| render() | Renders the pagination controls. | Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface |
Method Details
Creates a new instance with the specified pagination context.
| public abstract Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface context ( Yiisoft\Yii\DataView\Pagination\PaginationContext $context ) | ||
| $context | Yiisoft\Yii\DataView\Pagination\PaginationContext |
The pagination context to use. |
| return | Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface |
New instance with the specified context. |
|---|---|---|
public function context(PaginationContext $context): static;
Creates a new instance with the specified paginator.
| public abstract Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface paginator ( \Yiisoft\Data\Paginator\PaginatorInterface $paginator ) | ||
| $paginator | \Yiisoft\Data\Paginator\PaginatorInterface |
The paginator to use. |
| return | Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface |
New instance with the specified paginator. |
|---|---|---|
| throws | Yiisoft\Yii\DataView\Pagination\PaginatorNotSupportedException |
If the paginator type is not supported by the implementation. |
public function paginator(PaginatorInterface $paginator): static;
Signup or Login in order to comment.