1. Documentation
  2. API
  3. System
  4. Classes
  5. PagerElement

System\Classes\PagerElement

Overview

PagerElement is an internal class returned by the pager() Twig function. It also acts as an abstraction from Laravel's pagination features.

Implements
  • Illuminate\Contracts\Support\Arrayable
  • ArrayAccess
  • Illuminate\Contracts\Support\Jsonable
  • JsonSerializable
  • Stringable

Public Properties

public array $config

config values for this instance

public array $vars

view variables for this instance

Protected Properties

protected mixed $paginator

$paginator

Public Methods

public __construct()

public __construct($paginator, $config = []): void

public __get()

public __get(string $key): mixed

__get dynamically retrieves the value of an attribute.

public __isset()

public __isset(string $key): bool

__isset dynamically checks if an attribute is set.

public __set()

public __set(string $key, mixed $value): void

__set is disabled (read-only)

public __toString()

public __toString(): string

public __unset()

public __unset(string $key): void

__unset is disabled (read-only)

public get()

public get(string $key, mixed $default = null): mixed

get an attribute from the element instance.

public getConfig()

public getConfig($name, $default = null): void

public jsonSerialize()

public jsonSerialize(): array

jsonSerialize converts the object into something JSON serializable.

public offsetExists()

public offsetExists(string $offset): bool

offsetExists determines if the given offset exists.

public offsetGet()

public offsetGet(string $offset): mixed

offsetGet gets the value for a given offset.

public offsetSet()

public offsetSet(string $offset, mixed $value): void

offsetSet is disabled (read-only)

public offsetUnset()

public offsetUnset(string $offset): void

offsetUnset is disabled (read-only)

public preparePager()

public preparePager(): void

public prepareVars()

public prepareVars(): void

prepareVars for render

public render()

public render(): void

render as a string

public setArrayMode()

public setArrayMode(): void

setArrayMode cleans up the variables for output as an array

public toArray()

public toArray(): array

toArray converts the element instance to an array.

public toJson()

public toJson(int $options = 0): string

toJson converts the element instance to JSON.

Protected Methods

protected getCmsController()

protected getCmsController(): void

protected getPaginatorElements()

protected getPaginatorElements(): array

getPaginatorElements is needed because it is locked out in Laravel

protected getPaginatorView()

protected getPaginatorView(): void