Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Interface DataProviderInterface

Maslosoft\Mangan\Interfaces\DataProviderInterface implements Maslosoft\Mangan\Interfaces\CriteriaAwareInterface, Maslosoft\Mangan\Interfaces\ModelAwareInterface, Maslosoft\Mangan\Interfaces\SortAwareInterface

Direct known implementers

Maslosoft\Mangan\DataProvider

Namespace: Maslosoft\Mangan\Interfaces
Author: Piotr Maselkowski
Located at Interfaces/DataProviderInterface.php

Methods summary

`public array`	# `getData( boolean $refresh = false )` Returns the data items currently available, ensures that result is at leas empty array Returns the data items currently available, ensures that result is at leas empty array Parameters `$refresh` whether the data should be re-fetched from persistent storage. Returns array the list of data items currently available in this data provider.
`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.
`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.
`public Maslosoft\Mangan\Interfaces\PaginationInterface\|Maslosoft\Mangan\Pagination\|false`	# `getPagination( string $className = Maslosoft\Mangan\Interfaces\Pagination::class )` Returns the pagination object. Returns the pagination object. Parameters `$className` the pagination object class name, use this param to override default pagination class. Returns `Maslosoft\Mangan\Interfaces\PaginationInterface`\|`Maslosoft\Mangan\Pagination`\|false the pagination object. If this is false, it means the pagination is disabled.
`public`	# `setPagination( boolean\|string\|array\|Maslosoft\Mangan\Interfaces\PaginationInterface\|Maslosoft\Mangan\Pagination $pagination )` Set pagination. This method accepts following types: Set pagination. This method accepts following types: boolean - set to false to disable pagination completely string - pagination class name - will use default values array - EmbeDi compatible pagination configuration PaginationIntreface - Pagination interface compatible object instances Parameters `$pagination`

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Interfaces

Interface DataProviderInterface

Direct known implementers

Methods summary

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Methods inherited from Maslosoft\Mangan\Interfaces\CriteriaAwareInterface

Methods inherited from Maslosoft\Mangan\Interfaces\ModelAwareInterface

Methods inherited from Maslosoft\Mangan\Interfaces\SortAwareInterface

Contact us