CDataProvider

Property Details

data property

public array getData(boolean $refresh=false)
public void setData(array $value)

Returns the data items currently available.

id property

public string getId()
public void setId(string $value)

Returns the ID that uniquely identifies the data provider.

itemCount property read-only

public integer getItemCount(boolean $refresh=false)

Returns the number of data items in the current page. This is equivalent to count($provider->getData()). When pagination is set false, this returns the same value as totalItemCount.

keys property

public array getKeys(boolean $refresh=false)
public void setKeys(array $value)

Returns the key values associated with the data items.

pagination property

public CPagination|false getPagination(string $className='CPagination')
public void setPagination(mixed $value)

Returns the pagination object.

sort property

public CSort|false getSort(string $className='CSort')
public void setSort(mixed $value)

Returns the sort object.

totalItemCount property

public integer getTotalItemCount(boolean $refresh=false)
public void setTotalItemCount(integer $value)

Returns the total number of data items. When pagination is set false, this returns the same value as itemCount.

Method Details

calculateTotalItemCount() method

abstract protected integer calculateTotalItemCount()

abstract protected function calculateTotalItemCount();

Calculates the total number of data items.

fetchData() method

abstract protected array fetchData()

abstract protected function fetchData();

Fetches the data from the persistent data storage.

fetchKeys() method

abstract protected array fetchKeys()

abstract protected function fetchKeys();

Fetches the data item keys from the persistent data storage.

getData() method

public array getData(boolean $refresh=false)

public function getData($refresh=false)
{
    if($this->_data===null || $refresh)
        $this->_data=$this->fetchData();
    return $this->_data;
}

Returns the data items currently available.

getId() method

public string getId()

public function getId()
{
    return $this->_id;
}

Returns the ID that uniquely identifies the data provider.

getItemCount() method

public integer getItemCount(boolean $refresh=false)

public function getItemCount($refresh=false)
{
    return count($this->getData($refresh));
}

Returns the number of data items in the current page. This is equivalent to count($provider->getData()). When pagination is set false, this returns the same value as totalItemCount.

getKeys() method

public array getKeys(boolean $refresh=false)

public function getKeys($refresh=false)
{
    if($this->_keys===null || $refresh)
        $this->_keys=$this->fetchKeys();
    return $this->_keys;
}

Returns the key values associated with the data items.

getPagination() method

public CPagination|false getPagination(string $className='CPagination')

public function getPagination($className='CPagination')
{
    if($this->_pagination===null)
    {
        $this->_pagination=new $className;
        if(($id=$this->getId())!='')
            $this->_pagination->pageVar=$id.'_page';
    }
    return $this->_pagination;
}

Returns the pagination object.

getSort() method

public CSort|false getSort(string $className='CSort')

public function getSort($className='CSort')
{
    if($this->_sort===null)
    {
        $this->_sort=new $className;
        if(($id=$this->getId())!='')
            $this->_sort->sortVar=$id.'_sort';
    }
    return $this->_sort;
}

Returns the sort object.

getTotalItemCount() method

public integer getTotalItemCount(boolean $refresh=false)

public function getTotalItemCount($refresh=false)
{
    if($this->_totalItemCount===null || $refresh)
        $this->_totalItemCount=$this->calculateTotalItemCount();
    return $this->_totalItemCount;
}

Returns the total number of data items. When pagination is set false, this returns the same value as itemCount.

setData() method

public void setData(array $value)

public function setData($value)
{
    $this->_data=$value;
}

Sets the data items for this provider.

setId() method

public void setId(string $value)

public function setId($value)
{
    $this->_id=$value;
}

Sets the provider ID.

setKeys() method

public void setKeys(array $value)

public function setKeys($value)
{
    $this->_keys=$value;
}

Sets the data item keys for this provider.

setPagination() method

public void setPagination(mixed $value)

array(
    'class' => 'MyPagination',
    'pageSize' => 20,
),

public function setPagination($value)
{
    if(is_array($value))
    {
        if(isset($value['class']))
        {
            $pagination=$this->getPagination($value['class']);
            unset($value['class']);
        }
        else
            $pagination=$this->getPagination();

        foreach($value as $k=>$v)
            $pagination->$k=$v;
    }
    else
        $this->_pagination=$value;
}

Sets the pagination for this data provider.

setSort() method

public void setSort(mixed $value)

array(
    'class' => 'MySort',
    'attributes' => array('name', 'weight'),
),

public function setSort($value)
{
    if(is_array($value))
    {
        if(isset($value['class']))
        {
            $sort=$this->getSort($value['class']);
            unset($value['class']);
        }
        else
            $sort=$this->getSort();

        foreach($value as $k=>$v)
            $sort->$k=$v;
    }
    else
        $this->_sort=$value;
}

Sets the sorting for this data provider.

setTotalItemCount() method (available since v1.1.1)

public void setTotalItemCount(integer $value)

public function setTotalItemCount($value)
{
    $this->_totalItemCount=$value;
}

Sets the total number of data items. This method is provided in case when the total number cannot be determined by calculateTotalItemCount.