PHP Class Pimcore\Model\Tool\Targeting\Rule

Inheritance: extends Pimcore\Model\AbstractModel
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$actions Pimcore\Model\Tool\Targeting\Rule\Actions
$active boolean
$conditions array
$description string
$id integer
$name string
$scope string

Public Methods

Method Description
fireEvent ( $key, $value = null )
getActions ( ) : Pimcore\Model\Tool\Targeting\Rule\Actions
getActive ( ) : boolean
getById ( integer $id ) : Rule Static helper to retrieve an instance of Tool\Targeting\Rule by the given ID
getByName ( $name ) : null | Rule
getConditions ( ) : array
getDescription ( ) : string
getId ( ) : integer
getName ( ) : string
getScope ( ) : string
inTarget ( $target ) : boolean
setActions ( $actions )
setActive ( boolean $active )
setConditions ( $conditions )
setDescription ( $description )
setId ( $id )
setName ( $name )
setScope ( string $scope )

Method Details

fireEvent() public static method

public static fireEvent ( $key, $value = null )
$key
$value

getActions() public method

public getActions ( ) : Pimcore\Model\Tool\Targeting\Rule\Actions
return Pimcore\Model\Tool\Targeting\Rule\Actions

getActive() public method

public getActive ( ) : boolean
return boolean

getById() public static method

Static helper to retrieve an instance of Tool\Targeting\Rule by the given ID
public static getById ( integer $id ) : Rule
$id integer
return Rule

getByName() public static method

public static getByName ( $name ) : null | Rule
$name
return null | Rule

getConditions() public method

public getConditions ( ) : array
return array

getDescription() public method

public getDescription ( ) : string
return string

getId() public method

public getId ( ) : integer
return integer

getName() public method

public getName ( ) : string
return string

getScope() public method

public getScope ( ) : string
return string

inTarget() public static method

public static inTarget ( $target ) : boolean
$target
return boolean

setActions() public method

public setActions ( $actions )
$actions

setActive() public method

public setActive ( boolean $active )
$active boolean

setConditions() public method

public setConditions ( $conditions )
$conditions

setDescription() public method

public setDescription ( $description )
$description

setId() public method

public setId ( $id )
$id

setName() public method

public setName ( $name )
$name

setScope() public method

public setScope ( string $scope )
$scope string

Property Details

$actions public property

public Actions,Pimcore\Model\Tool\Targeting\Rule $actions
return Pimcore\Model\Tool\Targeting\Rule\Actions

$active public property

public bool $active
return boolean

$conditions public property

public array $conditions
return array

$description public property

public string $description
return string

$id public property

public int $id
return integer

$name public property

public string $name
return string

$scope public property

public string $scope
return string