- Theme Engine
- Design Principles
- Templates
- EVML Reference
- Output
- Comments
- Operators
- Statements and Declarations
- Built-in Functions
- Built-in Objects
- Account
- Address
- Array
- Boolean
- Branch
- Cart
- CartLine
- Category
- CategoryCollection
- CategoryFilter
- CategoryFilterCollection
- CategoryFilterOption
- CategorySearch
- Collection
- Color
- Contact
- Currency
- Date
- Discount
- Dom
- Event
- EventCollection
- EventSlot
- Image
- Layout
- Locale
- Money
- Number
- Object
- Page
- PageCollection
- PageSearch
- PageSharer
- Pagination
- Postage
- Price
- PriceDiscount
- Product
- ProductCollection
- ProductCustomisation
- ProductDownload
- ProductMedia
- ProductMediaFrame
- ProductPrice
- ProductSearch
- ProductSpecification
- ProductSpecificationValue
- ProductVariation
- ProductVariationOption
- RecentlyViewed
- RegExp
- Request
- Review
- ReviewCollection
- Search
- SearchCollection
- SearchResult
- String
- Tag
- Template
- Url
- Website
- EV Tags
- CSS Pre-processor
- Ajax API
Pagination
Extends Object. The Pagination object is generally used in conjunction with Search, PageSearch, CategorySearch or ProductSearch objects.
Properties | |
---|---|
name |
Type String or Null Currently not implemented. |
page |
Type Number The current page number starting from 1 |
perPage |
Type Number or Null The number of rows to retrieve per page |
search |
Type Search The search algorithm used to get a list of pages, categories or products. The type of search may be Search, PageSearch, CategorySearch or ProductSearch |
Methods | |
---|---|
isFirstPage() |
Returns Boolean True if the current page is the first in the series. |
isLastPage() |
Returns Boolean True if the current page is the last in the series. |
nextPage() |
Returns Number or Null The next page number or null if no further pages are available in the series. |
page(Number:number) |
Sets the page number for the seearch algorithm and then returns the original Pagination object. |
perPage(Number:limit) |
Sets the perPage limit for the seearch algorithm and then returns the original Pagination object. |
previousPage() |
Returns Number or Null The page number for the previous page in the series or null if the current page isFirstPage. |
results() |
Returns Collection The result set returned from the executed search. The type of collection will depend on the search algorithm in use:
|
total() |
Returns Number The total number of results available for the search including those not returned on the current page. |
totalPages() |
Returns Number The total number of pages available for the search. |