PaginatedList
class PaginatedList extends ListDecorator
A decorator that wraps around a data list in order to provide pagination.
Traits
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on 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 {@link 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 {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link 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 {@link 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 {@link 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.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
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.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
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
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 {@link 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.
Get an array of XML-escaped values by field name
No description
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
No description
Adds an item to the list, making no guarantees about where it will appear.
Returns the total number of items in the list
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.
Return a new instance of this list based on reversing the current 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.
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 charactaristics.
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
Returns a new instance of this list where no more than $limit records are included.
Exclude the list to not contain items with these charactaristics
Returns the GET var that is used to set the page start. This defaults to "start".
Sets the GET var used to set the page start.
Returns the number of items displayed per page. This defaults to 10.
Set the number of items displayed per page. Set to zero to disable paging.
Sets the current page.
Returns the offset of the item the current page starts at.
Sets the offset of the item that current page starts at. This should be a multiple of the page length.
Returns the total number of items in the unpaginated list.
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.
No description
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.
No description
No description
No description
No description
No description
Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".
Returns the number of the last item being displayed on this page.
Returns a link to the first page.
Returns a link to the last page.
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.
Get the request object for this list
Details
in CustomMethods at line 50
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
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
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
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 {@link Object::$extensions} array. See {@link 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 {@link singleton()}).
in Extensible at line 224
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 {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $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))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
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 {@link __construct()} in {@link defineMethods()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link 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.
in Injectable at line 26
static Injectable
create(array $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'); $list = SiteTree::get();
in Injectable at line 43
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).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
at line 36
__construct(SS_List $list, array|ArrayAccess $request = array())
Constructs a new paginated list instance around a list.
in ViewableData at line 106
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.
in ViewableData at line 129
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 {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__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 {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 205
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 232
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link 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.
in ListDecorator at line 100
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in ViewableData at line 320
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.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
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
in ViewableData at line 471
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.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 530
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.
in ViewableData at line 545
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
at line 214
ArrayIterator
getIterator()
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::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".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in ListDecorator at line 33
SS_List
getList()
Returns the list this decorator wraps around.
in ListDecorator at line 46
SS_List
setList($list)
Set the list this decorator wraps around.
Useful for keeping a decorator/paginated list configuration intact while modifying the underlying list.
in ListDecorator at line 55
offsetExists($key)
in ListDecorator at line 60
offsetGet($key)
in ListDecorator at line 65
offsetSet($key, $value)
in ListDecorator at line 70
offsetUnset($key)
at line 230
array
toArray()
in ListDecorator at line 80
array
toNestedArray()
Returns the contents of the list as an array of maps.
in ListDecorator at line 85
add(mixed $item)
Adds an item to the list, making no guarantees about where it will appear.
in ListDecorator at line 90
remove($itemObject)
Removes an item from the list.
in ListDecorator at line 105
mixed
first()
Returns the first item in the list.
in ListDecorator at line 110
mixed
last()
Returns the last item in the list.
at line 521
TotalItems()
Returns the total number of items in the list
in ListDecorator at line 120
Count()
in ListDecorator at line 125
forTemplate()
in ListDecorator at line 130
Map
map($index = 'ID', $titleField = 'Title')
Returns a map of a key field to a value field of all the items in the list.
in ListDecorator at line 135
mixed
find(string $key, mixed $value)
Returns the first item in the list where the key field is equal to the value.
in ListDecorator at line 140
array
column($value = 'ID')
Returns an array of a single field value for all items in the list.
in ListDecorator at line 145
columnUnique($value = "ID")
in ListDecorator at line 150
$this
each(callable $callback)
Walks the list using the specified callback
in ListDecorator at line 155
bool
canSortBy(string $by)
Returns TRUE if the list can be sorted by a field.
in ListDecorator at line 160
Sortable
reverse()
Return a new instance of this list based on reversing the current sort.
in ListDecorator at line 174
Sortable
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.
in ListDecorator at line 179
bool
canFilterBy(string $by)
Returns TRUE if the list can be filtered by a given field expression.
in ListDecorator at line 192
Filterable
filter()
Filter the list to include items with these charactaristics
in ListDecorator at line 219
Filterable
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
in ListDecorator at line 233
Filterable
filterByCallback(callable $callback)
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
in ListDecorator at line 250
Limitable
limit(int $limit, int $offset)
Returns a new instance of this list where no more than $limit records are included.
If $offset is specified, then that many records at the beginning of the list will be skipped. This matches the behaviour of the SQL LIMIT clause.
in ListDecorator at line 261
mixed
byID(int $id)
Return the first item with the given ID
in ListDecorator at line 272
SS_List
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
in ListDecorator at line 285
Filterable
exclude()
Exclude the list to not contain items with these charactaristics
in ListDecorator at line 290
debug()
at line 55
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 neccesary to set a different get var for each using {@link setPaginationGetVar()}.
at line 66
$this
setPaginationGetVar(string $var)
Sets the GET var used to set the page start.
at line 77
int.
getPageLength()
Returns the number of items displayed per page. This defaults to 10.
at line 88
$this
setPageLength(int $length)
Set the number of items displayed per page. Set to zero to disable paging.
at line 100
$this
setCurrentPage(int $page)
Sets the current page.
at line 111
int
getPageStart()
Returns the offset of the item the current page starts at.
at line 135
$this
setPageStart(int $start)
Sets the offset of the item that current page starts at. This should be a multiple of the page length.
at line 146
int
getTotalItems()
Returns the total number of items in the unpaginated list.
at line 162
$this
setTotalItems(int $items)
Sets the total number of items in the list. This is useful when doing custom pagination.
at line 175
$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.
at line 196
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 {@link setLimitItems} to control this.
at line 205
$this
setLimitItems(bool $limit)
at line 253
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.
at line 325
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 %>
Prev
<% end_if %>
<% loop MyPages.PaginationSummary(4) %>
<% if CurrentBool %>
$PageNum
<% else %>
<% if Link %>
$PageNum
<% else %>
...
<% end_if %>
<% end_if %>
<% end_loop %>
<% if MyPages.NotLastPage %>
Next
<% end_if %>
<% end_if %>
at line 385
int
CurrentPage()
at line 396
int
TotalPages()
at line 407
bool
MoreThanOnePage()
at line 415
bool
NotFirstPage()
at line 423
bool
NotLastPage()
at line 434
int
FirstItem()
Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".
at line 444
int
LastItem()
Returns the number of the last item being displayed on this page.
at line 461
string
FirstLink()
Returns a link to the first page.
at line 475
string
LastLink()
Returns a link to the last page.
at line 490
string
NextLink()
Returns a link to the next page, if there is another page after the current one.
at line 507
string
PrevLink()
Returns a link to the previous page, if the first page is not currently active.
at line 531
setRequest(HTTPRequest|ArrayAccess $request)
Set the request object for this list
at line 539
getRequest()
Get the request object for this list