class PaginatedList extends ListDecorator (View source)

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 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 SS_List $list from  ListDecorator
protected $request
protected $getVar
protected $pageLength
protected $pageStart
protected $totalItems
protected $limitItems

Methods

public
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

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

protected
array
getExtraMethodConfig(string $method)

Get meta-data details on a named method

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected
array
findMethodsFromExtension(object $extension) deprecated

No description

protected
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

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
constructExtensions() deprecated

No description

protected
defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

public static 
bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

public static 
array
get_extensions(string $class = null, bool $includeArgumentString = false)

No description

public static 
array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

public static 
bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

public
array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

public
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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

public
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
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.

public
getExtensionInstances()

Get all extension instances for this specific object instance.

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
__construct(SS_List $list, array|ArrayAccess $request = [])

Constructs a new paginated list instance around a list.

public
bool
__isset(string $property)

Check if a field exists on this object or its failover.

public
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.

public
__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.

public
setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

public
mixed
getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

public
$this
setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

public
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.

public
bool
exists()

Return true if this object "exists" i.e. has a sensible value

public
string
__toString()

No description

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
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.

public
string
castingClass(string $field)

Get the class name a field on this object will be casted to.

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
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)

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

public
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.

public
object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.

public
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.

public
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.

public
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

public
getIterator()

No description

public
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

public
Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

public
string
ThemeDir() deprecated

Return the directory if the current active theme (relative to the site root).

public
string
CSSClasses(string $stopAtClass = self::class)

Get part of the current classes ancestry to be used as a CSS class.

public
Debug()

Return debug information about this object that can be rendered into a template

public
getList()

Returns the list this decorator wraps around.

public
setList($list)

Set the list this decorator wraps around.

public
offsetExists($key)

No description

public
offsetGet($key)

No description

public
offsetSet($key, $value)

No description

public
offsetUnset($key)

No description

public
array
toArray()

Returns all the items in the list in an array.

public
array
toNestedArray()

Returns the contents of the list as an array of maps.

public
add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

public
remove($itemObject)

Removes an item from the list.

public
mixed
first()

Returns the first item in the list.

public
mixed
last()

Returns the last item in the list.

public
TotalItems()

Returns the total number of items in the list

public
Count()

No description

public
forTemplate()

No description

public
Map
map($index = 'ID', $titleField = 'Title')

Returns a map of a key field to a value field of all the items in the list.

public
mixed
find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

public
array
column($value = 'ID')

Returns an array of a single field value for all items in the list.

public
columnUnique($value = "ID")

No description

public
$this
each(callable $callback)

Walks the list using the specified callback

public
bool
canSortBy(string $by)

Returns TRUE if the list can be sorted by a field.

public
reverse()

Return a new instance of this list based on reversing the current sort.

public
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.

public
bool
canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

public
filter()

Filter the list to include items with these characteristics

public
filterAny()

Return a copy of this list which contains items matching any of these characteristics.

public
filterByCallback(callable $callback)

Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.

public
limit(int $limit, int $offset = 0)

Returns a new instance of this list where no more than $limit records are included.

public
mixed
byID(int $id)

Return the first item with the given ID

public
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

public
exclude()

Exclude the list to not contain items with these characteristics

public
debug()

No description

public
string
getPaginationGetVar()

Returns the GET var that is used to set the page start. This defaults to "start".

public
$this
setPaginationGetVar(string $var)

Sets the GET var used to set the page start.

public
int
getPageLength()

Returns the number of items displayed per page. This defaults to 10.

public
$this
setPageLength(int $length)

Set the number of items displayed per page. Set to zero to disable paging.

public
$this
setCurrentPage(int $page)

Sets the current page.

public
int
getPageStart()

Returns the offset of the item the current page starts at.

public
$this
setPageStart(int $start)

Sets the offset of the item that current page starts at. This should be a multiple of the page length.

public
int
getTotalItems()

Returns the total number of items in the unpaginated list.

public
$this
setTotalItems(int $items)

Sets the total number of items in the list. This is useful when doing custom pagination.

public
$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.

public
bool
getLimitItems()

Returns whether or not the underlying list is limited to the current pagination range when iterating.

public
$this
setLimitItems(bool $limit)

No description

public
Pages(int $max = null)

Returns a set of links to all the pages in the list. This is useful for basic pagination.

public
PaginationSummary(int $context = 4)

Returns a summarised pagination which limits the number of pages shown around the current page for visually balanced.

public
int
CurrentPage()

No description

public
int
TotalPages()

No description

public
bool
MoreThanOnePage()

No description

public
bool
FirstPage()

No description

public
bool
NotFirstPage()

No description

public
bool
LastPage()

No description

public
bool
NotLastPage()

No description

public
int
FirstItem()

Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".

public
int
LastItem()

Returns the number of the last item being displayed on this page.

public
string
FirstLink()

Returns a link to the first page.

public
string
LastLink()

Returns a link to the last page.

public
string
NextLink()

Returns a link to the next page, if there is another page after the current one.

public
string
PrevLink()

Returns a link to the previous page, if the first page is not currently active.

public
setRequest(HTTPRequest|ArrayAccess $request)

Set the request object for this list

public
getRequest()

Get the request object for this list

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()

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

Parameters

string $name
callable $callback

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

Parameters

string $method

Return Value

bool

protected array getExtraMethodConfig(string $method)

Get meta-data details on a named method

Parameters

string $method

Return Value

array

List of custom method details, if defined for this method

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

protected array findMethodsFromExtension(object $extension) deprecated

deprecated 4.13.0 Will be replaced by findMethodsFrom() in CMS 5

No description

Parameters

object $extension

Return Value

array

protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

Exceptions

InvalidArgumentException

protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

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)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected addCallbackMethod(string $method, callable $callback)

Add callback as a method.

Parameters

string $method

Name of method

callable $callback

Callback to invoke. Note: $this is passed as first parameter to this callback and then $args as array

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.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

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.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected constructExtensions() deprecated

deprecated 4.0.0:5.0.0 Extensions and methods are now lazy-loaded

No description

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()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of Extension with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool

Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

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.

Add support for removing extensions with parameters

Parameters

string $extension

class name of an Extension subclass, without parameters

static array get_extensions(string $class = null, bool $includeArgumentString = false)

No description

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either DataExtension class names, or eval'ed class name strings with constructor arguments.

static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

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))

Parameters

string $classOrExtension

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

if the extension has to match the required extension and not be a subclass

Return Value

bool

Flag if the extension exists

array invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

Parameters

string $method

the method name to call

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

List of results with nulls filtered out

array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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().

Parameters

string $method

the name of the method to call on each extension

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

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()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

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.

Return Value

Extension[]

Map of DataExtension instances, keyed by classname.

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();

Parameters

mixed ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(SS_List $list, array|ArrayAccess $request = [])

Constructs a new paginated list instance around a list.

Parameters

SS_List $list
array|ArrayAccess $request

Either a map of request parameters or request object that the pagination offset is read from.

Exceptions

Exception

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.

Parameters

string $property

Return Value

bool

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.

Parameters

string $property

Return Value

mixed

__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.

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

bool

mixed getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

mixed

$this setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

Parameters

string $field
mixed $value

Return Value

$this

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.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

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

Return Value

bool

string __toString()

No description

Return Value

string

the class name

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

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.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

string castingClass(string $field)

Get the class name a field on this object will be casted to.

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

DBHTMLText

protected string objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

Return Value

string

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected $this objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

Return Value

$this

protected $this objCacheClear()

Clear object cache

Return Value

$this

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.

Parameters

string $fieldName
array $arguments
bool $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

object|DBField cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

ArrayIterator getIterator()

No description

Return Value

ArrayIterator

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

ViewableData Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

Return Value

ViewableData

string ThemeDir() deprecated

deprecated 4.0.1 Use ModuleResourceLoader::resourcePath() or ModuleResourceLoader::resourceURL() 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.

Return Value

string

URL to the current theme

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".

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

Return debug information about this object that can be rendered into a template

Return Value

ViewableData_Debugger

SS_List getList()

Returns the list this decorator wraps around.

Return Value

SS_List

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.

Parameters

$list

Return Value

SS_List

offsetExists($key)

No description

Parameters

$key

offsetGet($key)

No description

Parameters

$key

offsetSet($key, $value)

No description

Parameters

$key
$value

offsetUnset($key)

No description

Parameters

$key

array toArray()

Returns all the items in the list in an array.

Return Value

array

array toNestedArray()

Returns the contents of the list as an array of maps.

Return Value

array

add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

Parameters

mixed $item

remove($itemObject)

Removes an item from the list.

Parameters

$itemObject

mixed first()

Returns the first item in the list.

Return Value

mixed

mixed last()

Returns the last item in the list.

Return Value

mixed

TotalItems()

Returns the total number of items in the list

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.

Parameters

$index
$titleField

Return Value

Map

mixed find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

Parameters

string $key
mixed $value

Return Value

mixed

array column($value = 'ID')

Returns an array of a single field value for all items in the list.

Parameters

$value

Return Value

array

columnUnique($value = "ID")

No description

Parameters

$value

$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

bool canSortBy(string $by)

Returns TRUE if the list can be sorted by a field.

Parameters

string $by

Return Value

bool

Sortable reverse()

Return a new instance of this list based on reversing the current sort.

Return Value

Sortable

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.

Return Value

Sortable

Examples

$list->sort('Name'); // default ASC sorting
$list->sort('Name DESC'); // DESC sorting
$list->sort('Name', 'ASC');
$list->sort(array('Name'=>'ASC,'Age'=>'DESC'));

bool canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

Parameters

string $by

Return Value

bool

Filterable filter()

Filter the list to include items with these characteristics

Return Value

Filterable

Examples

$list->filter('Name', 'bob'); // only bob in list
$list->filter('Name', array('aziz', 'bob'); // aziz and bob in list
$list->filter(array('Name'=>'bob, 'Age'=>21)); // bob or someone with Age 21
$list->filter(array('Name'=>'bob, 'Age'=>array(21, 43))); // bob or anyone with Age 21 or 43

Filterable filterAny()

Return a copy of this list which contains items matching any of these characteristics.

Return Value

Filterable

Examples

// only bob in the list
$list = $list->filterAny('Name', 'bob');
// SQL: WHERE "Name" = 'bob'
// azis or bob in the list
$list = $list->filterAny('Name', array('aziz', 'bob');
// SQL: WHERE ("Name" IN ('aziz','bob'))
// bob or anyone aged 21 in the list
$list = $list->filterAny(array('Name'=>'bob, 'Age'=>21));
// SQL: WHERE ("Name" = 'bob' OR "Age" = '21')
// bob or anyone aged 21 or 43 in the list
$list = $list->filterAny(array('Name'=>'bob, 'Age'=>array(21, 43)));
// SQL: WHERE ("Name" = 'bob' OR ("Age" IN ('21', '43'))
// all bobs, phils or anyone aged 21 or 43 in the list
$list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
// SQL: WHERE (("Name" IN ('bob', 'phil')) OR ("Age" IN ('21', '43'))

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.

Parameters

callable $callback

Return Value

Filterable

See also

Filterable::filterByCallback

Examples

$list = $list->filterByCallback(function($item, $list) { return $item->Age == 9; })

Limitable limit(int $limit, int $offset = 0)

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.

Parameters

int $limit
int $offset

Return Value

Limitable

mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

SS_List byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids

Array of integers

Return Value

SS_List

Filterable exclude()

Exclude the list to not contain items with these characteristics

Return Value

Filterable

Examples

$list->exclude('Name', 'bob'); // exclude bob from list
$list->exclude('Name', array('aziz', 'bob'); // exclude aziz and bob from list
$list->exclude(array('Name'=>'bob, 'Age'=>21)); // exclude bob or someone with Age 21
$list->exclude(array('Name'=>'bob, 'Age'=>array(21, 43))); // exclude bob or anyone with Age 21 or 43

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().

Return Value

string

$this setPaginationGetVar(string $var)

Sets the GET var used to set the page start.

Parameters

string $var

Return Value

$this

int getPageLength()

Returns the number of items displayed per page. This defaults to 10.

Return Value

int

$this setPageLength(int $length)

Set the number of items displayed per page. Set to zero to disable paging.

Parameters

int $length

Return Value

$this

$this setCurrentPage(int $page)

Sets the current page.

Parameters

int $page

Page index beginning with 1

Return Value

$this

int getPageStart()

Returns the offset of the item the current page starts at.

Return Value

int

$this setPageStart(int $start)

Sets the offset of the item that current page starts at. This should be a multiple of the page length.

Parameters

int $start

Return Value

$this

int getTotalItems()

Returns the total number of items in the unpaginated list.

Return Value

int

$this setTotalItems(int $items)

Sets the total number of items in the list. This is useful when doing custom pagination.

Parameters

int $items

Return Value

$this

$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.

Parameters

SQLSelect $query

Return Value

$this

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.

Return Value

bool

$this setLimitItems(bool $limit)

No description

Parameters

bool $limit

Return Value

$this

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.

Parameters

int $max

Return Value

SS_List

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 %>

Parameters

int $context

The number of pages to display around the current page. The number should be event, as half the number of each pages are displayed on either side of the current one.

Return Value

SS_List

int CurrentPage()

No description

Return Value

int

int TotalPages()

No description

Return Value

int

bool MoreThanOnePage()

No description

Return Value

bool

bool FirstPage()

No description

Return Value

bool

bool NotFirstPage()

No description

Return Value

bool

bool LastPage()

No description

Return Value

bool

bool NotLastPage()

No description

Return Value

bool

int FirstItem()

Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".

Return Value

int

int LastItem()

Returns the number of the last item being displayed on this page.

Return Value

int

Returns a link to the first page.

Return Value

string

Returns a link to the last page.

Return Value

string

Returns a link to the next page, if there is another page after the current one.

Return Value

string

Returns a link to the previous page, if the first page is not currently active.

Return Value

string

setRequest(HTTPRequest|ArrayAccess $request)

Set the request object for this list

Parameters

HTTPRequest|ArrayAccess $request

getRequest()

Get the request object for this list