170 lines
3.5 KiB
YAML
170 lines
3.5 KiB
YAML
name: Paginator
|
|
class_comment: null
|
|
dependencies:
|
|
- name: ArrayAccess
|
|
type: class
|
|
source: ArrayAccess
|
|
- name: Countable
|
|
type: class
|
|
source: Countable
|
|
- name: PaginatorContract
|
|
type: class
|
|
source: Illuminate\Contracts\Pagination\Paginator
|
|
- name: Arrayable
|
|
type: class
|
|
source: Illuminate\Contracts\Support\Arrayable
|
|
- name: Jsonable
|
|
type: class
|
|
source: Illuminate\Contracts\Support\Jsonable
|
|
- name: Collection
|
|
type: class
|
|
source: Illuminate\Support\Collection
|
|
- name: IteratorAggregate
|
|
type: class
|
|
source: IteratorAggregate
|
|
- name: JsonSerializable
|
|
type: class
|
|
source: JsonSerializable
|
|
properties:
|
|
- name: hasMore
|
|
visibility: protected
|
|
comment: '# * Determine if there are more items in the data source.
|
|
|
|
# *
|
|
|
|
# * @return bool'
|
|
methods:
|
|
- name: __construct
|
|
visibility: public
|
|
parameters:
|
|
- name: items
|
|
- name: perPage
|
|
- name: currentPage
|
|
default: 'null'
|
|
- name: options
|
|
default: '[]'
|
|
comment: "# * Determine if there are more items in the data source.\n# *\n# * @return\
|
|
\ bool\n# */\n# protected $hasMore;\n# \n# /**\n# * Create a new paginator instance.\n\
|
|
# *\n# * @param mixed $items\n# * @param int $perPage\n# * @param int|null\
|
|
\ $currentPage\n# * @param array $options (path, query, fragment, pageName)\n\
|
|
# * @return void"
|
|
- name: setCurrentPage
|
|
visibility: protected
|
|
parameters:
|
|
- name: currentPage
|
|
comment: '# * Get the current page for the request.
|
|
|
|
# *
|
|
|
|
# * @param int $currentPage
|
|
|
|
# * @return int'
|
|
- name: setItems
|
|
visibility: protected
|
|
parameters:
|
|
- name: items
|
|
comment: '# * Set the items for the paginator.
|
|
|
|
# *
|
|
|
|
# * @param mixed $items
|
|
|
|
# * @return void'
|
|
- name: nextPageUrl
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the URL for the next page.
|
|
|
|
# *
|
|
|
|
# * @return string|null'
|
|
- name: links
|
|
visibility: public
|
|
parameters:
|
|
- name: view
|
|
default: 'null'
|
|
- name: data
|
|
default: '[]'
|
|
comment: '# * Render the paginator using the given view.
|
|
|
|
# *
|
|
|
|
# * @param string|null $view
|
|
|
|
# * @param array $data
|
|
|
|
# * @return string'
|
|
- name: render
|
|
visibility: public
|
|
parameters:
|
|
- name: view
|
|
default: 'null'
|
|
- name: data
|
|
default: '[]'
|
|
comment: '# * Render the paginator using the given view.
|
|
|
|
# *
|
|
|
|
# * @param string|null $view
|
|
|
|
# * @param array $data
|
|
|
|
# * @return \Illuminate\Contracts\Support\Htmlable'
|
|
- name: hasMorePagesWhen
|
|
visibility: public
|
|
parameters:
|
|
- name: hasMore
|
|
default: 'true'
|
|
comment: '# * Manually indicate that the paginator does have more pages.
|
|
|
|
# *
|
|
|
|
# * @param bool $hasMore
|
|
|
|
# * @return $this'
|
|
- name: hasMorePages
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Determine if there are more items in the data source.
|
|
|
|
# *
|
|
|
|
# * @return bool'
|
|
- name: toArray
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the instance as an array.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: jsonSerialize
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Convert the object into something JSON serializable.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: toJson
|
|
visibility: public
|
|
parameters:
|
|
- name: options
|
|
default: '0'
|
|
comment: '# * Convert the object to its JSON representation.
|
|
|
|
# *
|
|
|
|
# * @param int $options
|
|
|
|
# * @return string'
|
|
traits:
|
|
- ArrayAccess
|
|
- Countable
|
|
- Illuminate\Contracts\Support\Arrayable
|
|
- Illuminate\Contracts\Support\Jsonable
|
|
- Illuminate\Support\Collection
|
|
- IteratorAggregate
|
|
- JsonSerializable
|
|
interfaces:
|
|
- Arrayable
|