PHP Interface Sulu\Bundle\ResourceBundle\Resource\FilterManagerInterface

Show file Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
batchDelete ( $ids ) Deletes multiple filters at once.
delete ( $id ) Removes a filter with the given id.
findByIdAndLocale ( integer $id, string $locale ) : Filter Finds a filter by id and locale.
findFiltersForUserAndContext ( string $context, $userId, string $locale ) : Filter[] Finds all filters filtered by context and user and for the given locale.
getFeaturesForContext ( $context ) : array | null Returns the configured features for a context.
getFieldDescriptors ( $locale ) : DoctrineFieldDescriptor[] Returns an array of field descriptors.
getListFieldDescriptors ( $locale ) : DoctrineFieldDescriptor[] Returns an array of field descriptors specific for the list.
hasContext ( $context ) : boolean Checks if the context exists.
isFeatureEnabled ( $context, $feature ) : boolean Checks if a feature is enabled for a context.
save ( array $data, string $locale, integer $userId, integer $id = null ) : Filter Saves the given filter.

Method Details

batchDelete() public method

Deletes multiple filters at once.
public batchDelete ( $ids )
$ids

delete() public method

Removes a filter with the given id.
public delete ( $id )
$id

findByIdAndLocale() public method

Finds a filter by id and locale.
public findByIdAndLocale ( integer $id, string $locale ) : Filter
$id integer
$locale string
return Sulu\Bundle\ResourceBundle\Api\Filter

findFiltersForUserAndContext() public method

Finds all filters filtered by context and user and for the given locale.
public findFiltersForUserAndContext ( string $context, $userId, string $locale ) : Filter[]
$context string
$userId
$locale string
return Sulu\Bundle\ResourceBundle\Api\Filter[]

getFeaturesForContext() public method

Returns the configured features for a context.
public getFeaturesForContext ( $context ) : array | null
$context
return array | null

getFieldDescriptors() public method

Returns an array of field descriptors.
public getFieldDescriptors ( $locale ) : DoctrineFieldDescriptor[]
$locale
return Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptor[]

getListFieldDescriptors() public method

Returns an array of field descriptors specific for the list.
public getListFieldDescriptors ( $locale ) : DoctrineFieldDescriptor[]
$locale
return Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptor[]

hasContext() public method

Checks if the context exists.
public hasContext ( $context ) : boolean
$context
return boolean

isFeatureEnabled() public method

Checks if a feature is enabled for a context.
public isFeatureEnabled ( $context, $feature ) : boolean
$context
$feature
return boolean

save() public method

Saves the given filter.
public save ( array $data, string $locale, integer $userId, integer $id = null ) : Filter
$data array
$locale string
$userId integer
$id integer
return Sulu\Bundle\ResourceBundle\Api\Filter