Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class DataProvider

Mongo document data provider

Implements a data provider based on Document.

DataProvider provides data in terms of Document objects which are of class modelClass. It uses the AR EntityManager::findAll method to retrieve the data from database. The query property can be used to specify various query options, such as conditions, sorting, pagination, etc.

Maslosoft\Mangan\DataProvider implements Maslosoft\Mangan\Interfaces\DataProviderInterface uses Maslosoft\Mangan\Traits\DataProvider\ConfigureTrait, Maslosoft\Mangan\Traits\DataProvider\CriteriaTrait, Maslosoft\Mangan\Traits\DataProvider\DataTrait, Maslosoft\Mangan\Traits\ModelAwareTrait, Maslosoft\Mangan\Traits\DataProvider\PaginationTrait, Maslosoft\Mangan\Traits\SortAwareTrait

Namespace: Maslosoft\Mangan
Author: Ianaré Sévi
Author: Dariusz Górecki darek.krk@gmail.com
Author: Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
Copyright: 2011 CleverIT http://www.cleverit.com.pl
Since: v1.0
Located at DataProvider.php

Methods summary

`public`	# `__construct( mixed $modelClass, array $config = [] )` Constructor. Constructor. Parameters `$modelClass` the model class (e.g. 'Post') or the model finder instance (e.g. Post::model() , Post::model()->published() ). `$config` configuration (name=>value) to be applied as the initial property values of this class. Since v1.0
`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. 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. Parameters `$refresh` whether the number of data items should be re-calculated. Returns integer the number of data items in the current page. Implementation of `Maslosoft\Mangan\Interfaces\DataProviderInterface::getItemCount()`
`public integer`	# `getTotalItemCount( )` Returns the total number of data items. When pagination is set false, this returns the same value as itemCount. Returns the total number of data items. When pagination is set false, this returns the same value as itemCount. Returns integer total number of possible data items. Implementation of `Maslosoft\Mangan\Interfaces\DataProviderInterface::getTotalItemCount()`

Constants summary

`string`	`CriteriaClass`	# `Criteria::class`

Properties summary

Properties used from Maslosoft\Mangan\Traits\ModelAwareTrait

$model

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class DataProvider

Methods summary

Parameters

Since

Parameters

Returns

Implementation of

Returns

Implementation of

Methods inherited from Maslosoft\Mangan\Interfaces\DataProviderInterface

Methods inherited from Maslosoft\Mangan\Interfaces\SortAwareInterface

Methods inherited from Maslosoft\Mangan\Interfaces\ModelAwareInterface

Methods inherited from Maslosoft\Mangan\Interfaces\CriteriaAwareInterface

Methods used from Maslosoft\Mangan\Traits\DataProvider\ConfigureTrait

Methods used from Maslosoft\Mangan\Traits\DataProvider\CriteriaTrait

Methods used from Maslosoft\Mangan\Traits\DataProvider\DataTrait

Methods used from Maslosoft\Mangan\Traits\SortAwareTrait

Constants summary

Properties summary

Properties used from Maslosoft\Mangan\Traits\ModelAwareTrait

Contact us