PaginatedList deprecated
class PaginatedList extends ListDecorator (View source)
deprecated
A decorator that wraps around a data list in order to provide pagination.
Traits
Allows an object to have extensions applied to it.
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to declare a set of custom methods
Config options
| extensions | array | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| casting | array | An array of objects to cast certain fields to. This is set up as an array in the format: |
from ViewableData |
| default_cast | string | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
| casting_cache | array | from ViewableData |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom public methods. |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | ViewableData | $failover | A failover object to attempt to get data from if it is not present on this object. |
from ViewableData |
| protected | ViewableData | $customisedObject | from ViewableData | |
| protected | T> | $list | from ListDecorator | |
| protected | $request | |||
| protected | $getVar | |||
| protected | $pageLength | |||
| protected | $pageStart | |||
| protected | $totalItems | |||
| protected | $limitItems |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Determines if a custom method with this name is defined.
Get meta-data details on a named method
Return the names of all the methods available on this object
Get all public built in methods for this class
Find all methods on the given object.
Add all the methods from an object property.
Add all the methods from an object property (which is an Extension) to this object.
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Add callback as a method.
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
Adds any methods from Extension instances attached to this object.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Constructs a new paginated list instance around a list.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Return true if this object "exists" i.e. has a sensible value
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
Store a value in the field cache
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Returns the contents of the list as an array of maps.
Adds an item to the list, making no guarantees about where it will appear.
Returns a map of a key field to a value field of all the items in the list.
Returns the first item in the list where the key field is equal to the value.
Returns an array of a single field value for all items in the list.
Returns TRUE if the list can be sorted by a field.
Sorts this list by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.
Returns TRUE if the list can be filtered by a given field expression.
Return a copy of this list which contains items matching any of these characteristics.
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
Exclude the list to not contain items with these characteristics
Returns the GET var that is used to set the page start. This defaults to "start".
Set the number of items displayed per page. Set to zero to disable paging.
Sets the offset of the item that current page starts at. This should be a multiple of the page length.
Sets the total number of items in the list. This is useful when doing custom pagination.
Sets the page length, page start and total items from a query object's limit, offset and unlimited count. The query MUST have a limit clause.
Returns whether or not the underlying list is limited to the current pagination range when iterating.
Returns a set of links to all the pages in the list. This is useful for basic pagination.
Returns a summarised pagination which limits the number of pages shown around the current page for visually balanced.
Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".
Returns a link to the next page, if there is another page after the current one.
Returns a link to the previous page, if the first page is not currently active.
Details
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
protected bool
hasCustomMethod($method)
Determines if a custom method with this name is defined.
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
static protected array
findBuiltInMethods(string|object $class = null)
Get all public built in methods for this class
protected array
findMethodsFrom(object $object)
Find all methods on the given object.
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
array
invokeWithExtensions(string $method, mixed ...$arguments)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed ...$arguments)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
__construct(SS_List|Sortable|Filterable|Limitable $list, array|ArrayAccess $request = [])
Constructs a new paginated list instance around a list.
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
mixed
getDynamicData(string $field)
No description
ViewableData
setDynamicData(string $field, mixed $value)
No description
bool
hasDynamicData(string $field)
No description
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overridden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database
string
__toString()
No description
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
string
castingClass(string $field)
deprecated
deprecated
Get the class name a field on this object will be casted to.
string
escapeTypeForField(string $field)
deprecated
deprecated
Return the string-format type for the given field.
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
protected string
objCacheName(string $fieldName, array $arguments)
deprecated
deprecated
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected $this
objCacheSet(string $key, mixed $value)
Store a value in the field cache
protected $this
objCacheClear()
Clear object cache
object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
object|DBField
cachedCall(string $fieldName, array $arguments = [], string $identifier = null)
deprecated
deprecated
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = [], bool $cache = true)
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
string
XML_val(string $field, array $arguments = [], bool $cache = false)
deprecated
deprecated
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
array
getXMLValues(array $fields)
deprecated
deprecated
Get an array of XML-escaped values by field name
Traversable
getIterator()
No description
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
CSSClasses(string $stopAtClass = ViewableData::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
SS_List&Sortable&Filterable&Limitable
getList()
No description
ListDecorator
setList(SS_List&Sortable&Filterable&Limitable $list)
No description
bool
offsetExists(mixed $key)
No description
mixed
offsetGet(mixed $key)
No description
void
offsetSet(mixed $key, mixed $value)
No description
void
offsetUnset(mixed $key)
No description
T[]
toArray()
No description
array
toNestedArray()
Returns the contents of the list as an array of maps.
add(mixed $item)
Adds an item to the list, making no guarantees about where it will appear.
remove($itemObject)
Removes an item from the list.
T|null
first()
Returns the first item in the list.
T|null
last()
Returns the last item in the list.
int
TotalItems()
Returns the total number of items in the list
int
Count()
No description
forTemplate()
No description
Map
map($index = 'ID', $titleField = 'Title')
Returns a map of a key field to a value field of all the items in the list.
T|null
find(string $key, mixed $value)
Returns the first item in the list where the key field is equal to the value.
array
column($value = 'ID')
Returns an array of a single field value for all items in the list.
columnUnique($value = "ID")
No description
each($callback)
No description
bool
canSortBy(string $by)
Returns TRUE if the list can be sorted by a field.
reverse()
No description
sort()
Sorts this list by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.
bool
canFilterBy(string $by)
Returns TRUE if the list can be filtered by a given field expression.
filter()
Filter the list to include items with these characteristics
filterAny()
Return a copy of this list which contains items matching any of these characteristics.
T>
filterByCallback(callable $callback)
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
Limitable
limit(int|null $length, int $offset = 0)
No description
T|null
byID(int $id)
Return the first item with the given ID
byIDs($ids)
Filter this list to only contain the given Primary IDs
exclude()
Exclude the list to not contain items with these characteristics
debug()
No description
string
getPaginationGetVar()
Returns the GET var that is used to set the page start. This defaults to "start".
If there is more than one paginated list on a page, it is necessary to set a different get var for each using setPaginationGetVar().
$this
setPaginationGetVar(string $var)
Sets the GET var used to set the page start.
int
getPageLength()
Returns the number of items displayed per page. This defaults to 10.
$this
setPageLength(int $length)
Set the number of items displayed per page. Set to zero to disable paging.
$this
setCurrentPage(int $page)
Sets the current page.
int
getPageStart()
Returns the offset of the item the current page starts at.
$this
setPageStart(int $start)
Sets the offset of the item that current page starts at. This should be a multiple of the page length.
int
getTotalItems()
Returns the total number of items in the unpaginated list.
$this
setTotalItems(int $items)
Sets the total number of items in the list. This is useful when doing custom pagination.
$this
setPaginationFromQuery(SQLSelect $query)
Sets the page length, page start and total items from a query object's limit, offset and unlimited count. The query MUST have a limit clause.
bool
getLimitItems()
Returns whether or not the underlying list is limited to the current pagination range when iterating.
By default the limit method will be called on the underlying list to extract the subset for the current page. In some situations, if the list is custom generated and already paginated you don't want to additionally limit the list. You can use setLimitItems to control this.
$this
setLimitItems(bool $limit)
No description
SS_List
Pages(int $max = null)
Returns a set of links to all the pages in the list. This is useful for basic pagination.
By default it returns links to every page, but if you pass the $max parameter the number of pages will be limited to that number, centered around the current page.
SS_List
PaginationSummary(int $context = 4)
Returns a summarised pagination which limits the number of pages shown around the current page for visually balanced.
Example: 25 pages total, currently on page 6, context of 4 pages [prev] [1] ... [4] [5] [[6]] [7] [8] ... [25] [next]
Example template usage:
<% if MyPages.MoreThanOnePage %>
<% if MyPages.NotFirstPage %>
<a class="prev" href="$MyPages.PrevLink">Prev</a>
<% end_if %>
<% loop MyPages.PaginationSummary(4) %>
<% if CurrentBool %>
$PageNum
<% else %>
<% if Link %>
<a href="$Link">$PageNum</a>
<% else %>
...
<% end_if %>
<% end_if %>
<% end_loop %>
<% if MyPages.NotLastPage %>
<a class="next" href="$MyPages.NextLink">Next</a>
<% end_if %>
<% end_if %>
int
CurrentPage()
No description
int
TotalPages()
No description
bool
MoreThanOnePage()
No description
bool
FirstPage()
No description
bool
NotFirstPage()
No description
bool
LastPage()
No description
bool
NotLastPage()
No description
int
FirstItem()
Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".
int
LastItem()
Returns the number of the last item being displayed on this page.
string
FirstLink()
Returns a link to the first page.
string
LastLink()
Returns a link to the last page.
string
NextLink()
Returns a link to the next page, if there is another page after the current one.
string
PrevLink()
Returns a link to the previous page, if the first page is not currently active.
setRequest(HTTPRequest|ArrayAccess $request)
Set the request object for this list
getRequest()
Get the request object for this list