598 lines
13 KiB
YAML
598 lines
13 KiB
YAML
|
name: AbstractCursorPaginator
|
||
|
|
class_comment: null
|
||
|
|
dependencies:
|
||
|
|
- name: ArrayAccess
|
||
|
|
type: class
|
||
|
|
source: ArrayAccess
|
||
|
|
- name: Closure
|
||
|
|
type: class
|
||
|
|
source: Closure
|
||
|
|
- name: Exception
|
||
|
|
type: class
|
||
|
|
source: Exception
|
||
|
|
- name: Htmlable
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Contracts\Support\Htmlable
|
||
|
|
- name: Model
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Database\Eloquent\Model
|
||
|
|
- name: Pivot
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Database\Eloquent\Relations\Pivot
|
||
|
|
- name: JsonResource
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Http\Resources\Json\JsonResource
|
||
|
|
- name: Arr
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Support\Arr
|
||
|
|
- name: Collection
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Support\Collection
|
||
|
|
- name: Str
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Support\Str
|
||
|
|
- name: ForwardsCalls
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Support\Traits\ForwardsCalls
|
||
|
|
- name: Tappable
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Support\Traits\Tappable
|
||
|
|
- name: Stringable
|
||
|
|
type: class
|
||
|
|
source: Stringable
|
||
|
|
- name: Traversable
|
||
|
|
type: class
|
||
|
|
source: Traversable
|
||
|
|
properties:
|
||
|
|
- name: items
|
||
|
|
visibility: protected
|
||
|
|
comment: "# * @mixin \\Illuminate\\Support\\Collection\n# */\n# abstract class AbstractCursorPaginator\
|
||
|
|
\ implements Htmlable, Stringable\n# {\n# use ForwardsCalls, Tappable;\n# \n#\
|
||
|
|
\ /**\n# * All of the items being paginated.\n# *\n# * @var \\Illuminate\\Support\\\
|
||
|
|
Collection"
|
||
|
|
- name: perPage
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The number of items to be shown per page.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var int'
|
||
|
|
- name: path
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The base path to assign to all URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: query
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The query parameters to add to all URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var array'
|
||
|
|
- name: fragment
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The URL fragment to add to all URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string|null'
|
||
|
|
- name: cursorName
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The cursor string variable used to store the page.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: cursor
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The current cursor.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var \Illuminate\Pagination\Cursor|null'
|
||
|
|
- name: parameters
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The paginator parameters for the cursor.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var array'
|
||
|
|
- name: options
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The paginator options.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var array'
|
||
|
|
- name: currentCursorResolver
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The current cursor resolver callback.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var \Closure'
|
||
|
|
methods:
|
||
|
|
- name: url
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: cursor
|
||
|
|
comment: "# * @mixin \\Illuminate\\Support\\Collection\n# */\n# abstract class AbstractCursorPaginator\
|
||
|
|
\ implements Htmlable, Stringable\n# {\n# use ForwardsCalls, Tappable;\n# \n#\
|
||
|
|
\ /**\n# * All of the items being paginated.\n# *\n# * @var \\Illuminate\\Support\\\
|
||
|
|
Collection\n# */\n# protected $items;\n# \n# /**\n# * The number of items to be\
|
||
|
|
\ shown per page.\n# *\n# * @var int\n# */\n# protected $perPage;\n# \n# /**\n\
|
||
|
|
# * The base path to assign to all URLs.\n# *\n# * @var string\n# */\n# protected\
|
||
|
|
\ $path = '/';\n# \n# /**\n# * The query parameters to add to all URLs.\n# *\n\
|
||
|
|
# * @var array\n# */\n# protected $query = [];\n# \n# /**\n# * The URL fragment\
|
||
|
|
\ to add to all URLs.\n# *\n# * @var string|null\n# */\n# protected $fragment;\n\
|
||
|
|
# \n# /**\n# * The cursor string variable used to store the page.\n# *\n# * @var\
|
||
|
|
\ string\n# */\n# protected $cursorName = 'cursor';\n# \n# /**\n# * The current\
|
||
|
|
\ cursor.\n# *\n# * @var \\Illuminate\\Pagination\\Cursor|null\n# */\n# protected\
|
||
|
|
\ $cursor;\n# \n# /**\n# * The paginator parameters for the cursor.\n# *\n# *\
|
||
|
|
\ @var array\n# */\n# protected $parameters;\n# \n# /**\n# * The paginator options.\n\
|
||
|
|
# *\n# * @var array\n# */\n# protected $options;\n# \n# /**\n# * The current cursor\
|
||
|
|
\ resolver callback.\n# *\n# * @var \\Closure\n# */\n# protected static $currentCursorResolver;\n\
|
||
|
|
# \n# /**\n# * Get the URL for a given cursor.\n# *\n# * @param \\Illuminate\\\
|
||
|
|
Pagination\\Cursor|null $cursor\n# * @return string"
|
||
|
|
- name: previousPageUrl
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the URL for the previous page.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string|null'
|
||
|
|
- name: nextPageUrl
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * The URL for the next page, or null.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string|null'
|
||
|
|
- name: previousCursor
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the "cursor" that points to the previous set of items.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \Illuminate\Pagination\Cursor|null'
|
||
|
|
- name: nextCursor
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the "cursor" that points to the next set of items.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \Illuminate\Pagination\Cursor|null'
|
||
|
|
- name: getCursorForItem
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: item
|
||
|
|
- name: isNext
|
||
|
|
default: 'true'
|
||
|
|
comment: '# * Get a cursor instance for the given item.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \ArrayAccess|\stdClass $item
|
||
|
|
|
||
|
|
# * @param bool $isNext
|
||
|
|
|
||
|
|
# * @return \Illuminate\Pagination\Cursor'
|
||
|
|
- name: getParametersForItem
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: item
|
||
|
|
comment: '# * Get the cursor parameters for a given object.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \ArrayAccess|\stdClass $item
|
||
|
|
|
||
|
|
# * @return array
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @throws \Exception'
|
||
|
|
- name: getPivotParameterForItem
|
||
|
|
visibility: protected
|
||
|
|
parameters:
|
||
|
|
- name: item
|
||
|
|
- name: parameterName
|
||
|
|
comment: '# * Get the cursor parameter value from a pivot model if applicable.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \ArrayAccess|\stdClass $item
|
||
|
|
|
||
|
|
# * @param string $parameterName
|
||
|
|
|
||
|
|
# * @return string|null'
|
||
|
|
- name: ensureParameterIsPrimitive
|
||
|
|
visibility: protected
|
||
|
|
parameters:
|
||
|
|
- name: parameter
|
||
|
|
comment: '# * Ensure the parameter is a primitive type.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * This can resolve issues that arise the developer uses a value object for an
|
||
|
|
attribute.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $parameter
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: fragment
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: fragment
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Get / set the URL fragment to be appended to URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string|null $fragment
|
||
|
|
|
||
|
|
# * @return $this|string|null'
|
||
|
|
- name: appends
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: key
|
||
|
|
- name: value
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Add a set of query string values to the paginator.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param array|string|null $key
|
||
|
|
|
||
|
|
# * @param string|null $value
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: appendArray
|
||
|
|
visibility: protected
|
||
|
|
parameters:
|
||
|
|
- name: keys
|
||
|
|
comment: '# * Add an array of query string values.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param array $keys
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: withQueryString
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Add all current query string values to the paginator.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: addQuery
|
||
|
|
visibility: protected
|
||
|
|
parameters:
|
||
|
|
- name: key
|
||
|
|
- name: value
|
||
|
|
comment: '# * Add a query string value to the paginator.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $key
|
||
|
|
|
||
|
|
# * @param string $value
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: buildFragment
|
||
|
|
visibility: protected
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Build the full fragment portion of a URL.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
- name: loadMorph
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: relation
|
||
|
|
- name: relations
|
||
|
|
comment: '# * Load a set of relationships onto the mixed relationship collection.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $relation
|
||
|
|
|
||
|
|
# * @param array $relations
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: loadMorphCount
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: relation
|
||
|
|
- name: relations
|
||
|
|
comment: '# * Load a set of relationship counts onto the mixed relationship collection.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $relation
|
||
|
|
|
||
|
|
# * @param array $relations
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: items
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the slice of items being paginated.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return array'
|
||
|
|
- name: through
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: callback
|
||
|
|
comment: '# * Transform each item in the slice of items using a callback.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param callable $callback
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: perPage
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the number of items shown per page.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return int'
|
||
|
|
- name: cursor
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the current cursor being paginated.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \Illuminate\Pagination\Cursor|null'
|
||
|
|
- name: getCursorName
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the query string variable used to store the cursor.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
- name: setCursorName
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: name
|
||
|
|
comment: '# * Set the query string variable used to store the cursor.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $name
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: withPath
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: path
|
||
|
|
comment: '# * Set the base path to assign to all URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $path
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: setPath
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: path
|
||
|
|
comment: '# * Set the base path to assign to all URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $path
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: path
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the base path for paginator generated URLs.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string|null'
|
||
|
|
- name: resolveCurrentCursor
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: cursorName
|
||
|
|
default: '''cursor'''
|
||
|
|
- name: default
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Resolve the current cursor or return the default value.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $cursorName
|
||
|
|
|
||
|
|
# * @return \Illuminate\Pagination\Cursor|null'
|
||
|
|
- name: currentCursorResolver
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: resolver
|
||
|
|
comment: '# * Set the current cursor resolver callback.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \Closure $resolver
|
||
|
|
|
||
|
|
# * @return void'
|
||
|
|
- name: viewFactory
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get an instance of the view factory from the resolver.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \Illuminate\Contracts\View\Factory'
|
||
|
|
- name: getIterator
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get an iterator for the items.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \ArrayIterator'
|
||
|
|
- name: isEmpty
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Determine if the list of items is empty.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return bool'
|
||
|
|
- name: isNotEmpty
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Determine if the list of items is not empty.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return bool'
|
||
|
|
- name: count
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the number of items for the current page.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return int'
|
||
|
|
- name: getCollection
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the paginator''s underlying collection.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \Illuminate\Support\Collection'
|
||
|
|
- name: setCollection
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: collection
|
||
|
|
comment: '# * Set the paginator''s underlying collection.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \Illuminate\Support\Collection $collection
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: getOptions
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the paginator options.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return array'
|
||
|
|
- name: offsetExists
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: key
|
||
|
|
comment: '# * Determine if the given item exists.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $key
|
||
|
|
|
||
|
|
# * @return bool'
|
||
|
|
- name: offsetGet
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: key
|
||
|
|
comment: '# * Get the item at the given offset.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $key
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: offsetSet
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: key
|
||
|
|
- name: value
|
||
|
|
comment: '# * Set the item at the given offset.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $key
|
||
|
|
|
||
|
|
# * @param mixed $value
|
||
|
|
|
||
|
|
# * @return void'
|
||
|
|
- name: offsetUnset
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: key
|
||
|
|
comment: '# * Unset the item at the given key.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $key
|
||
|
|
|
||
|
|
# * @return void'
|
||
|
|
- name: toHtml
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Render the contents of the paginator to HTML.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
- name: __call
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: method
|
||
|
|
- name: parameters
|
||
|
|
comment: '# * Make dynamic calls into the collection.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $method
|
||
|
|
|
||
|
|
# * @param array $parameters
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: __toString
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Render the contents of the paginator when casting to a string.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
traits:
|
||
|
|
- ArrayAccess
|
||
|
|
- Closure
|
||
|
|
- Exception
|
||
|
|
- Illuminate\Contracts\Support\Htmlable
|
||
|
|
- Illuminate\Database\Eloquent\Model
|
||
|
|
- Illuminate\Database\Eloquent\Relations\Pivot
|
||
|
|
- Illuminate\Http\Resources\Json\JsonResource
|
||
|
|
- Illuminate\Support\Arr
|
||
|
|
- Illuminate\Support\Collection
|
||
|
|
- Illuminate\Support\Str
|
||
|
|
- Illuminate\Support\Traits\ForwardsCalls
|
||
|
|
- Illuminate\Support\Traits\Tappable
|
||
|
|
- Stringable
|
||
|
|
- Traversable
|
||
|
|
- ForwardsCalls
|
||
|
|
interfaces:
|
||
|
|
- Htmlable
|