CBasePager

Property Details

currentPage property

public integer getCurrentPage(boolean $recalculate=true)
public void setCurrentPage(integer $value)

the zero-based index of the current page. Defaults to 0.

itemCount property

public integer getItemCount()
public void setItemCount(integer $value)

total number of items.

pageCount property read-only

public integer getPageCount()

number of pages

pageSize property

public integer getPageSize()
public void setPageSize(integer $value)

number of items in each page.

pages property

public CPagination getPages()
public void setPages(CPagination $pages)

Returns the pagination information used by this pager.

Method Details

createPageUrl() method

protected string createPageUrl(integer $page)

protected function createPageUrl($page)
{
    return $this->getPages()->createPageUrl($this->getController(),$page);
}

Creates the URL suitable for pagination.

createPages() method

protected CPagination createPages()

protected function createPages()
{
    return new CPagination;
}

Creates the default pagination. This is called by getPages when the pagination is not set before.

getCurrentPage() method

public integer getCurrentPage(boolean $recalculate=true)

public function getCurrentPage($recalculate=true)
{
    return $this->getPages()->getCurrentPage($recalculate);
}

getItemCount() method

public integer getItemCount()

public function getItemCount()
{
    return $this->getPages()->getItemCount();
}

getPageCount() method

public integer getPageCount()

public function getPageCount()
{
    return $this->getPages()->getPageCount();
}

getPageSize() method

public integer getPageSize()

public function getPageSize()
{
    return $this->getPages()->getPageSize();
}

getPages() method

public CPagination getPages()

public function getPages()
{
    if($this->_pages===null)
        $this->_pages=$this->createPages();
    return $this->_pages;
}

Returns the pagination information used by this pager.

setCurrentPage() method

public void setCurrentPage(integer $value)

public function setCurrentPage($value)
{
    $this->getPages()->setCurrentPage($value);
}

setItemCount() method

public void setItemCount(integer $value)

public function setItemCount($value)
{
    $this->getPages()->setItemCount($value);
}

setPageSize() method

public void setPageSize(integer $value)

public function setPageSize($value)
{
    $this->getPages()->setPageSize($value);
}

setPages() method

public void setPages(CPagination $pages)

public function setPages($pages)
{
    $this->_pages=$pages;
}

Sets the pagination information used by this pager.