PHP Interface Sulu\Component\SmartContent\DataProviderInterface

显示文件 Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
getConfiguration ( ) : Sulu\Component\SmartContent\Configuration\ProviderConfigurationInterface Returns configuration for smart-content.
getDefaultPropertyParameter ( ) : PropertyParameter[] Returns default parameter.
resolveDataItems ( array $filters, array $propertyParameter, array $options = [], integer | null $limit = null, integer $page = 1, integer | null $pageSize = null ) : DataProviderResult Resolves given filters and returns filtered data items.
resolveDatasource ( mixed $datasource, array $propertyParameter, array $options ) : Sulu\Component\SmartContent\DatasourceItemInterface Resolves datasource and returns the data of it.
resolveResourceItems ( array $filters, array $propertyParameter, array $options = [], integer | null $limit = null, integer $page = 1, integer | null $pageSize = null ) : DataProviderResult Resolves given filters and returns filtered resource items with ArrayAccess.

Method Details

getConfiguration() public method

Returns configuration for smart-content.
public getConfiguration ( ) : Sulu\Component\SmartContent\Configuration\ProviderConfigurationInterface
return Sulu\Component\SmartContent\Configuration\ProviderConfigurationInterface

getDefaultPropertyParameter() public method

Returns default parameter.
public getDefaultPropertyParameter ( ) : PropertyParameter[]
return Sulu\Component\Content\Compat\PropertyParameter[]

resolveDataItems() public method

Resolves given filters and returns filtered data items.
public resolveDataItems ( array $filters, array $propertyParameter, array $options = [], integer | null $limit = null, integer $page = 1, integer | null $pageSize = null ) : DataProviderResult
$filters array Contains the filter configuration
$propertyParameter array Contains the parameter of resolved property
$options array Options like webspace or locale
$limit integer | null Indicates maximum size of result set
$page integer Indicates page of result set
$pageSize integer | null Indicates page-size of result set
return DataProviderResult

resolveDatasource() public method

Resolves datasource and returns the data of it.
public resolveDatasource ( mixed $datasource, array $propertyParameter, array $options ) : Sulu\Component\SmartContent\DatasourceItemInterface
$datasource mixed Identification of datasource
$propertyParameter array Contains the parameter of resolved property
$options array Options like webspace or locale
return Sulu\Component\SmartContent\DatasourceItemInterface

resolveResourceItems() public method

Resolves given filters and returns filtered resource items with ArrayAccess.
public resolveResourceItems ( array $filters, array $propertyParameter, array $options = [], integer | null $limit = null, integer $page = 1, integer | null $pageSize = null ) : DataProviderResult
$filters array Contains the filter configuration
$propertyParameter array Contains the parameter of resolved property
$options array Options like webspace or locale
$limit integer | null Indicates maximum size of result set
$page integer Indicates page of result set
$pageSize integer | null Indicates page-size of result set
return DataProviderResult