PaginateVariable
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\PaginateVariable
- Since
- 1.0
Paginate variable class.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $currentPage | |
| $first | |
| $last | |
| $total | |
| $totalPages |
# $currentPage
Signature
public $currentPage = null
# $first
Signature
public $first = null
# $last
Signature
public $last = null
# $total
Signature
public $total = 0
# $totalPages
Signature
public $totalPages = 0
# Public Methods
| Method | Description |
|---|---|
| getFirstUrl() | Returns the URL to the first page. |
| getLastUrl() | Returns the URL to the next page. |
| getNextUrl() | Returns the URL to the next page. |
| getNextUrls() | Returns next page URLs up to a certain distance from the current page. |
| getPageUrl() | Returns the URL to a specific page |
| getPrevUrl() | Returns the URL to the previous page. |
| getPrevUrls() | Returns previous page URLs up to a certain distance from the current page. |
| getRangeUrls() | Returns a range of page URLs. |
# getFirstUrl()
Signature
public string, null getFirstUrl ( )
# getLastUrl()
Signature
public string, null getLastUrl ( )
# getNextUrl()
Signature
public string, null getNextUrl ( )
# getNextUrls()
Returns next page URLs up to a certain distance from the current page.
View source (opens new window)
Arguments
$dist(integer (opens new window))
Returns
Signature
public array getNextUrls ( $dist = null )
# getPageUrl()
Returns the URL to a specific page
View source (opens new window)
Arguments
$page(integer (opens new window))
Returns
Signature
public string, null getPageUrl ( $page )
# getPrevUrl()
Signature
public string, null getPrevUrl ( )
# getPrevUrls()
Returns previous page URLs up to a certain distance from the current page.
View source (opens new window)
Arguments
$dist(integer (opens new window))
Returns
Signature
public array getPrevUrls ( $dist = null )
# getRangeUrls()
Returns a range of page URLs.
View source (opens new window)
Arguments
$start(integer (opens new window))$end(integer (opens new window))
Returns
Signature
public array getRangeUrls ( $start, $end )