CDataProvider

Подробное описание свойств

data свойство

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

Возвращает элементы данных, доступные в данный момент.

id свойство

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

Возвращает ID, уникально определяющий источник данных.

itemCount свойство только для чтения

public integer getItemCount(boolean $refresh=false)

Возвращает количество элементов данных на текущей странице. Это эквивалентно count($provider->getData()). Когда страничная навигация установлена в false, это возвращает то же значение, что и totalItemCount.

keys свойство

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

Возвращает значения ключей, связанные с элементами данных.

pagination свойство

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

Возвращает объект страничной навигации.

sort свойство

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

Возвращает объект сортировки.

totalItemCount свойство

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

Возвращает общее количество элементов данных. Когда страничная навигация установлена в false, это возвращает то же значение, что и itemCount.

Подробное описание методов

calculateTotalItemCount() метод

abstract protected integer calculateTotalItemCount()

abstract protected function calculateTotalItemCount();

Вычисляет общее количество элементов данных.

fetchData() метод

abstract protected array fetchData()

abstract protected function fetchData();

Извлекает данные из постоянного хранилища данных.

fetchKeys() метод

abstract protected array fetchKeys()

abstract protected function fetchKeys();

Извлекает ключи элементов данных из постоянного хранилища данных.

getData() метод

public array getData(boolean $refresh=false)

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

Возвращает доступные в данный момент элементы данных.

getId() метод

public string getId()

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

Возвращает идентификатор, который однозначно идентифицирует поставщика данных.

getItemCount() метод

public integer getItemCount(boolean $refresh=false)

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

Возвращает количество элементов данных на текущей странице. Это эквивалентно count($provider->getData()). Когда страничная навигация установлена в false, это возвращает то же значение, что и totalItemCount.

getKeys() метод

public array getKeys(boolean $refresh=false)

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

Возвращает значения ключей, связанные с элементами данных.

getPagination() метод

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;
}

Возвращает объект страничной навигации.

getSort() метод

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;
}

Возвращает объект сортировки.

getTotalItemCount() метод

public integer getTotalItemCount(boolean $refresh=false)

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

Возвращает общее количество элементов данных. Когда страничная навигация установлена в false, это возвращает то же значение, что и itemCount.

setData() метод

public void setData(array $value)

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

Устанавливает элементы данных для этого поставщика.

setId() метод

public void setId(string $value)

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

Устанавливает идентификатор поставщика.

setKeys() метод

public void setKeys(array $value)

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

Устанавливает ключи элементов данных для этого поставщика.

setPagination() метод

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;
}

Устанавливает постраничную навигацию для данного поставщика данных.

setSort() метод

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;
}

Устанавливает сортировку для данного поставщика данных.

setTotalItemCount() метод (доступен начиная с v1.1.1)

public void setTotalItemCount(integer $value)

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

Устанавливает общее количество элементов данных. Этот метод предоставляется в случае, когда общее количество нельзя определить с помощью calculateTotalItemCount.