PaginatedList
class PaginatedList extends SS_ListDecorator
A decorator that wraps around a data list in order to provide pagination.
Properties
| string | $class | from SS_Object |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
Return TRUE if a class has a specified extension.
Add an extension to a specific class.
No description
Constructs a new paginated list instance around a list.
Attemps 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
Check if this class is an instance of a specific class, or has that class as one of its parents
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.
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
Clears the cache for the given cacheToFile call
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.
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()}.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
Get the class name a field on this object will be casted to
Return the string-format type for the given field.
Save the casting cache for this object (including data from any failovers) into a variable
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.
Return the value of the field without any escaping being applied.
Return the value of a field in an SQL-safe format.
Return the value of a field in a JavaScript-save format.
Return the value of a field escaped suitable to be inserted into an XML node attribute.
No description
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Return the directory if the current active theme (relative to the site root).
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 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.
Filter the list to include items with these charactaristics
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.
Filter this list to only contain the given Primary IDs
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 SS_Object at line 60
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in SS_Object at line 132
static SS_Object
create()
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}
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 SS_Object at line 155
static SS_Object
singleton()
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 SS_Object at line 190
static
create_from_string($classSpec, $firstArg = null)
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.
Object::create_from_string("Versioned('Stage','Live')") will return the result of
Versioned::create('Stage', 'Live);
It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.
If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.
Object::create_from_string("Varchar(50)", "MyField") will return the result of
Vachar::create('MyField', '50');
Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.
in SS_Object at line 215
static
parse_class_spec($classSpec)
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Returns a 2-elemnent array, with classname and arguments
in SS_Object at line 341
static SS_Object
strong_create()
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
in SS_Object at line 361
static
useCustomClass(string $oldClass, string $newClass, bool $strong = false)
This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}
in SS_Object at line 375
static string
getCustomClass(string $class)
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
in SS_Object at line 396
static any
static_lookup($class, $name, null $default = null)
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
in SS_Object at line 436
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 444
static
set_static($class, $name, $value)
deprecated
deprecated
in SS_Object at line 452
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 460
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
in SS_Object at line 470
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
in SS_Object at line 478
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
in SS_Object at line 494
static
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 SS_Object at line 536
static
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 SS_Object at line 594
static
remove_extension(string $extension)
Remove an extension from a class.
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 SS_Object at line 633
static array
get_extensions(string $class, bool $includeArgumentString = false)
in SS_Object at line 655
static
get_extra_config_sources($class = null)
at line 26
__construct(SS_List $list, array|ArrayAccess $request = array())
Constructs a new paginated list instance around a list.
in SS_Object at line 725
mixed
__call(string $method, array $arguments)
Attemps 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 SS_Object at line 792
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 SS_Object at line 802
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in SS_Object at line 963
stat($name, $uncached = false)
in SS_Object at line 970
set_stat($name, $value)
in SS_Object at line 977
uninherited($name)
in SS_ListDecorator at line 85
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 SS_Object at line 998
string
parentClass()
in SS_Object at line 1008
bool
is_a(string $class)
Check if this class is an instance of a specific class, or has that class as one of its parents
in SS_Object at line 1015
string
__toString()
in SS_Object at line 1030
mixed
invokeWithExtensions(string $method, mixed $argument = null)
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 SS_Object at line 1058
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 {@link __construct()} in {@link defineMethods()}.
in SS_Object at line 1097
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in SS_Object at line 1115
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 SS_Object at line 1126
array
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).
in SS_Object at line 1142
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
in SS_Object at line 1171
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
in ViewableData at line 72
static string
castingObjectCreator(string $fieldSchema)
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
in ViewableData at line 83
static array
castingObjectCreatorPair(string $fieldSchema)
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.
in ViewableData at line 95
bool
__isset(string $property)
Check if a field exists on this object or its failover.
in ViewableData at line 117
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 138
__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 151
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 166
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 176
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 186
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 196
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 206
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 236
unknown
deprecatedCachedCall($method, $args = null, $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
in ViewableData at line 255
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 ViewableData at line 272
ViewableData
getCustomisedObj()
in ViewableData at line 279
setCustomisedObj(ViewableData $object)
in ViewableData at line 296
array
castingHelperPair(string $field)
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).
The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
in ViewableData at line 308
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.
in ViewableData at line 331
string
castingClass(string $field)
Get the class name a field on this object will be casted to
in ViewableData at line 346
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 357
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
in ViewableData at line 394
HTMLText
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 456
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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 503
cachedCall(string $field, array $arguments = null, 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 516
bool
hasValue(string $field, array $arguments = null, 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 538
XML_val($field, $arguments = null, $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 546
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
in ViewableData at line 579
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
at line 187
ArrayIterator
getIterator()
in ViewableData at line 611
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 627
string
ThemeDir(string $subtheme = false)
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 648
string
CSSClasses(string $stopAtClass = 'ViewableData')
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 671
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in SS_ListDecorator at line 28
SS_List
getList()
Returns the list this decorator wraps around.
in SS_ListDecorator at line 40
SS_List
setList(SS_List $list)
Set the list this decorator wraps around.
Useful for keeping a decorator/paginated list configuration intact while modifying the underlying list.
in SS_ListDecorator at line 49
offsetExists($key)
in SS_ListDecorator at line 53
offsetGet($key)
in SS_ListDecorator at line 57
offsetSet($key, $value)
in SS_ListDecorator at line 61
offsetUnset($key)
in SS_ListDecorator at line 65
array
toArray($index = null)
Returns all the items in the list in an array.
in SS_ListDecorator at line 69
array
toNestedArray($index = null)
Returns the contents of the list as an array of maps.
in SS_ListDecorator at line 73
add(mixed $item)
Adds an item to the list, making no guarantees about where it will appear.
in SS_ListDecorator at line 77
remove($itemObject)
Removes an item from the list.
in SS_ListDecorator at line 89
First()
in SS_ListDecorator at line 93
Last()
at line 441
TotalItems()
Returns the total number of items in the list
in SS_ListDecorator at line 101
Count()
in SS_ListDecorator at line 105
forTemplate()
in SS_ListDecorator at line 109
array
map($index = 'ID', $titleField = 'Title', $emptyString = null, $sort = false)
Returns a map of a key field to a value field of all the items in the list.
in SS_ListDecorator at line 113
mixed
find(string $key, mixed $value)
Returns the first item in the list where the key field is equal to the value.
in SS_ListDecorator at line 117
array
column($value = 'ID')
Returns an array of a single field value for all items in the list.
in SS_ListDecorator at line 121
mixed
each(callable $callback)
Walks the list using the specified callback
in SS_ListDecorator at line 125
bool
canSortBy(string $by)
Returns TRUE if the list can be sorted by a field.
in SS_ListDecorator at line 129
SS_Sortable
reverse()
Return a new instance of this list based on reversing the current sort.
in SS_ListDecorator at line 142
SS_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 SS_ListDecorator at line 147
bool
canFilterBy(string $by)
Returns TRUE if the list can be filtered by a given field expression.
in SS_ListDecorator at line 159
SS_Filterable
filter()
Filter the list to include items with these charactaristics
in SS_ListDecorator at line 186
DataList
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
in SS_ListDecorator at line 199
SS_Filterable
filterByCallback($callback)
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
in SS_ListDecorator at line 213
SS_Limitable
limit($limit, $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 SS_ListDecorator at line 223
mixed
byID(int $id)
Return the first item with the given ID
in SS_ListDecorator at line 233
SS_List
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
in SS_ListDecorator at line 245
SS_Filterable
exclude()
Exclude the list to not contain items with these charactaristics
in SS_ListDecorator at line 250
debug()
at line 44
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 53
setPaginationGetVar(string $var)
Sets the GET var used to set the page start.
at line 63
int.
getPageLength()
Returns the number of items displayed per page. This defaults to 10.
at line 73
$this
setPageLength(int $length)
Set the number of items displayed per page. Set to zero to disable paging.
at line 84
$this
setCurrentPage(int $page)
Sets the current page.
at line 94
int
getPageStart()
Returns the offset of the item the current page starts at.
at line 117
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 127
int
getTotalItems()
Returns the total number of items in the unpaginated list.
at line 141
setTotalItems(int $items)
Sets the total number of items in the list. This is useful when doing custom pagination.
at line 152
setPaginationFromQuery(SQLQuery $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 172
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 179
setLimitItems(bool $limit)
at line 210
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 277
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 332
int
CurrentPage()
at line 342
int
TotalPages()
at line 352
bool
MoreThanOnePage()
at line 359
bool
NotFirstPage()
at line 366
bool
NotLastPage()
at line 376
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 385
int
LastItem()
Returns the number of the last item being displayed on this page.
at line 401
string
FirstLink()
Returns a link to the first page.
at line 410
string
LastLink()
Returns a link to the last page.
at line 420
string
NextLink()
Returns a link to the next page, if there is another page after the current one.
at line 432
string
PrevLink()
Returns a link to the previous page, if the first page is not currently active.
at line 450
setRequest(SS_HTTPRequest $request)
Set the request object for this list
at line 457
getRequest()
Get the request object for this list