PHP Class Sulu\Bundle\ResourceBundle\Api\Filter

Inheritance: extends Sulu\Component\Rest\ApiWrapper

Show file Open project: sulu/sulu Class Usage Examples

Public Methods

Method	Description
__construct ( Filter $entity, string $locale )
addConditionGroup ( ConditionGroup $conditionGroup ) : Filter	Add conditionGroups.
addTranslation ( FilterTranslation $translation )	Add translations.
getChanged ( ) : DateTime	Sets the change time of the filter.
getChanger ( ) : Sulu\Component\Security\Authentication\UserInterface	Sets the changer of the filter.
getConditionGroups ( ) : null \| ConditionGroup[]	Get conditionGroups.
getConjunction ( ) : boolean	Get conjunction.
getContext ( ) : string	Get entity.
getCreated ( ) : DateTime	Sets the created time of the filter.
getCreator ( ) : Sulu\Component\Security\Authentication\UserInterface	Returns the creator of the filter.
getId ( ) : integer	Get id.
getName ( ) : string	Returns the name of the filter.
getPrivate ( ) : boolean	Get private flag.
getUser ( ) : Sulu\Component\Security\Authentication\UserInterface	Get user.
removeConditionGroup ( ConditionGroup $conditionGroup )	Remove conditionGroup.
removeTranslation ( FilterTranslation $translations ) : boolean	Remove translations.
setChanged ( DateTime $changed )	Sets the change time of the filter.
setChanger ( Sulu\Component\Security\Authentication\UserInterface $user )	Sets the changer of the filter.
setConjunction ( boolean $conjunction )	Set conjunction.
setContext ( $name )	Set context.
setCreated ( DateTime $created )	Sets the created time of the filter.
setCreator ( Sulu\Component\Security\Authentication\UserInterface $user )	Sets the creator of the filter.
setName ( string $name )	Sets the name of the filter.
setPrivate ( $private ) : Filter	Sets the private flag.
setUser ( Sulu\Component\Security\Authentication\UserInterface $user = null ) : Filter	Set user.

Private Methods

Method	Description
getTranslation ( ) : FilterTranslation	Get translation by locale.

Method Details

__construct() public method

public __construct ( Filter $entity, string $locale )
$entity	Sulu\Bundle\ResourceBundle\Entity\Filter
$locale	string

addConditionGroup() public method

Add conditionGroups.

public addConditionGroup ( ConditionGroup $conditionGroup ) : Filter
$conditionGroup	ConditionGroup
return	Filter

addTranslation() public method

Add translations.

public addTranslation ( FilterTranslation $translation )
$translation	Sulu\Bundle\ResourceBundle\Entity\FilterTranslation

getChanged() public method

Sets the change time of the filter.

public getChanged ( ) : DateTime
return	DateTime

getChanger() public method

Sets the changer of the filter.

public getChanger ( ) : Sulu\Component\Security\Authentication\UserInterface
return	Sulu\Component\Security\Authentication\UserInterface	creator/owner filter

getConditionGroups() public method

Get conditionGroups.

public getConditionGroups ( ) : null \| ConditionGroup[]
return	null \| ConditionGroup[]

getConjunction() public method

Get conjunction.

public getConjunction ( ) : boolean
return	boolean

getContext() public method

Get entity.

public getContext ( ) : string
return	string

getCreated() public method

Sets the created time of the filter.

public getCreated ( ) : DateTime
return	DateTime

getCreator() public method

Returns the creator of the filter.

public getCreator ( ) : Sulu\Component\Security\Authentication\UserInterface
return	Sulu\Component\Security\Authentication\UserInterface	creator/owner of the filter

getId() public method

Get id.

public getId ( ) : integer
return	integer

getName() public method

Returns the name of the filter.

public getName ( ) : string
return	string	The name of the filter

getPrivate() public method

Get private flag.

public getPrivate ( ) : boolean
return	boolean

getUser() public method

Get user.

public getUser ( ) : Sulu\Component\Security\Authentication\UserInterface
return	Sulu\Component\Security\Authentication\UserInterface

removeConditionGroup() public method

Remove conditionGroup.

public removeConditionGroup ( ConditionGroup $conditionGroup )
$conditionGroup	ConditionGroup

removeTranslation() public method

Remove translations.

public removeTranslation ( FilterTranslation $translations ) : boolean
$translations	Sulu\Bundle\ResourceBundle\Entity\FilterTranslation
return	boolean

setChanged() public method

Sets the change time of the filter.

public setChanged ( DateTime $changed )
$changed	DateTime

setChanger() public method

Sets the changer of the filter.

public setChanger ( Sulu\Component\Security\Authentication\UserInterface $user )
$user	Sulu\Component\Security\Authentication\UserInterface	The changer of the filter

setConjunction() public method

Set conjunction.

public setConjunction ( boolean $conjunction )
$conjunction	boolean

setContext() public method

Set context.

public setContext ( $name )
$name

setCreated() public method

Sets the created time of the filter.

public setCreated ( DateTime $created )
$created	DateTime

setCreator() public method

Sets the creator of the filter.

public setCreator ( Sulu\Component\Security\Authentication\UserInterface $user )
$user	Sulu\Component\Security\Authentication\UserInterface	The creator of the filter

setName() public method

Sets the name of the filter.

public setName ( string $name )
$name	string	The name of the filter

setPrivate() public method

Sets the private flag.

public setPrivate ( $private ) : Filter
$private		boolean
return	Sulu\Bundle\ResourceBundle\Entity\Filter

setUser() public method

Set user.

public setUser ( Sulu\Component\Security\Authentication\UserInterface $user = null ) : Filter
$user	Sulu\Component\Security\Authentication\UserInterface
return	Filter