class Illuminate / Pagination / Cursor
You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.

Cursor

Implements

  • Illuminate\...\Arrayable

Properties

protected

$parameters
  • array
    •

    The parameters associated with the cursor.

    Default: null
    protected

    $pointsToNextItems
  • bool
    •

    Determine whether the cursor points to the next or previous set of items.

    Default: null

    Methods

    public

    __construct ( array $parameters , $pointsToNextItems ) : void

    Create a new cursor instance.

    Parameters

    • $parameters array
    • $pointsToNextItems bool
    public

    parameter ( string $parameterName ) : string|null

    Get the given parameter from the cursor.

    Parameters

    • $parameterName string
    public

    parameters ( array $parameterNames ) : array

    Get the given parameters from the cursor.

    Parameters

    • $parameterNames array
    public

    pointsToNextItems ( ) : bool

    Determine whether the cursor points to the next set of items.

    public

    pointsToPreviousItems ( ) : bool

    Determine whether the cursor points to the previous set of items.

    public

    toArray ( ) : array

    Get the array representation of the cursor.

    public

    encode ( ) : string

    Get the encoded string representation of the cursor to construct a URL.

    public static

    fromEncoded ( $encodedString ) : static|null

    Get a cursor instance from the encoded string representation.

    Parameters

    • $encodedString string|null