class Rule extends AbstractRule

Class Rule

Properties

int $id from AbstractModel
static Dispatcher[] $conditionDispatcher from AbstractRule
static Dispatcher[] $actionDispatcher from AbstractRule
static string $type
string $name from AbstractRule
array $conditions from AbstractRule
array $actions from AbstractRule
static array $availableTypes Available Email Rule Types
static $conditionDispatchers
static $actionDispatchers
string $mailType
int $sort

Methods

static  null|AbstractModel
getById($id)

Get Range by id.

static  boolean
isMultiShop()

No description

static  boolean
isMultiShopFK()

No description

static  AbstractModel
create()

Create new instance of Pimcore Object.

static  AbstractModel|null
getByShopId($id, null $shopId = null)

No description

static  null|AbstractModel
getByField( string $field, string $value, int $shopId = null)

Get Range by id.

static  AbstractListing
getList()

get listing class.

static  AbstractModel[]
getAll()

Get all objects form this type.

int
getId()

No description

setId( int $id)

No description

string
getCacheKey()

No description

save()

save model to database.

bool
delete()

delete model.

getLocalizedFields()

Get LocalizedFields Provider.

setLocalizedFields($localizedFields)

Get LocalizedFields Provider.

AbstractModel
setValue($key, $value)

Override setValue function to support localized fields.

string
__toString()

No description

array
__sleep()

Prepare object to goto sleep.

__wakeup()

Prepare object to wakeup.

array
prepareActions($actions)

No description

mixed
prepareConditions($conditions)

No description

static  Dispatcher
getConditionDispatcher()

No description

static  Dispatcher
getActionDispatcher()

No description

static  string
getType()

No description

getMyConditionDispatcher()

No description

array
serialize()

No description

string
getName()

No description

setName( string $name)

No description

getConditions()

No description

setConditions( AbstractCondition[] $conditions)

No description

getActions()

No description

setActions( AbstractAction[] $actions)

No description

static  Dispatcher
getConditionDispatcherForType($type)

No description

static  Dispatcher
getActionDispatcherForType($type)

No description

static 
addConditionForType($condition, $type)

No description

static 
addActionForType($action, $type)

No description

static 
apply($type, AbstractModel $object, array $params = array())

Apply valid Order Rules

boolean
applyRule($object, array $params = array())

No description

bool
checkValidity( AbstractModel $object, array $params = array())

Check if Email Rule is valid

string
getValidationCacheKey( AbstractModel $object, array $params = array())

get cache key for mail rule validation

string
getMailType()

No description

setMailType( string $mailType)

No description

int
getSort()

No description

setSort( int $sort)

No description

Details

in AbstractModel at line line 72
static null|AbstractModel getById($id)

Get Range by id.

Parameters

$id

Return Value

null|AbstractModel

in AbstractModel at line line 80
static boolean isMultiShop()

Return Value

boolean

in AbstractModel at line line 94
static boolean isMultiShopFK()

Return Value

boolean

in AbstractModel at line line 112
static AbstractModel create()

Create new instance of Pimcore Object.

Return Value

AbstractModel

Exceptions

Exception

in AbstractModel at line line 122
static AbstractModel|null getByShopId($id, null $shopId = null)

Parameters

$id
null $shopId

Return Value

AbstractModel|null

in AbstractModel at line line 170
static null|AbstractModel getByField( string $field, string $value, int $shopId = null)

Get Range by id.

Parameters

string $field
string $value
int $shopId

Return Value

null|AbstractModel

in AbstractModel at line line 223
static AbstractListing getList()

get listing class.

Return Value

AbstractListing

Exceptions

Exception

in AbstractModel at line line 243
static AbstractModel[] getAll()

Get all objects form this type.

Return Value

AbstractModel[]

in AbstractModel at line line 253
int getId()

Return Value

int

in AbstractModel at line line 261
setId( int $id)

Parameters

int $id

in AbstractModel at line line 269
string getCacheKey()

Return Value

string

at line line 311
save()

save model to database.

in AbstractModel at line line 294
bool delete()

delete model.

Return Value

bool

in AbstractModel at line line 310
LocalizedFields|null getLocalizedFields()

Get LocalizedFields Provider.

Return Value

LocalizedFields|null

in AbstractModel at line line 329
setLocalizedFields($localizedFields)

Get LocalizedFields Provider.

Parameters

$localizedFields

in AbstractModel at line line 342
AbstractModel setValue($key, $value)

Override setValue function to support localized fields.

Parameters

$key
$value

Return Value

AbstractModel

in AbstractRule at line line 175
string __toString()

Return Value

string

in AbstractModel at line line 370
array __sleep()

Prepare object to goto sleep.

Return Value

array

in AbstractModel at line line 390
__wakeup()

Prepare object to wakeup.

in AbstractRule at line line 67
array prepareActions($actions)

Parameters

$actions

Return Value

array

Exceptions

Exception

in AbstractRule at line line 93
mixed prepareConditions($conditions)

Parameters

$conditions

Return Value

mixed

Exceptions

Exception

at line line 118
static Dispatcher getConditionDispatcher()

Return Value

Dispatcher

Exceptions

Exception

at line line 110
static Dispatcher getActionDispatcher()

Return Value

Dispatcher

Exceptions

Exception

in AbstractRule at line line 167
static string getType()

Return Value

string

at line line 204
getMyConditionDispatcher()

at line line 212
Dispatcher getMyActionDispatcher()

Return Value

Dispatcher

in AbstractRule at line line 201
array serialize()

Return Value

array

in AbstractRule at line line 226
string getName()

Return Value

string

in AbstractRule at line line 234
setName( string $name)

Parameters

string $name

in AbstractRule at line line 242
AbstractCondition[] getConditions()

Return Value

AbstractCondition[]

in AbstractRule at line line 250
setConditions( AbstractCondition[] $conditions)

Parameters

AbstractCondition[] $conditions

in AbstractRule at line line 258
AbstractAction[] getActions()

Return Value

AbstractAction[]

in AbstractRule at line line 266
setActions( AbstractAction[] $actions)

Parameters

AbstractAction[] $actions

at line line 128
static Dispatcher getConditionDispatcherForType($type)

Parameters

$type

Return Value

Dispatcher

at line line 143
static Dispatcher getActionDispatcherForType($type)

Parameters

$type

Return Value

Dispatcher

at line line 159
static addConditionForType($condition, $type)

Parameters

$condition
$type

at line line 172
static addActionForType($action, $type)

Parameters

$action
$type

at line line 186
static apply($type, AbstractModel $object, array $params = array())

Apply valid Order Rules

Parameters

$type
AbstractModel $object
array $params

at line line 223
boolean applyRule($object, array $params = array())

Parameters

$object
array $params

Return Value

boolean

at line line 241
bool checkValidity( AbstractModel $object, array $params = array())

Check if Email Rule is valid

Parameters

AbstractModel $object
array $params

Return Value

bool

at line line 292
string getValidationCacheKey( AbstractModel $object, array $params = array())

get cache key for mail rule validation

Parameters

AbstractModel $object
array $params

Return Value

string

at line line 321
string getMailType()

Return Value

string

at line line 329
setMailType( string $mailType)

Parameters

string $mailType

at line line 337
int getSort()

Return Value

int

at line line 345
setSort( int $sort)

Parameters

int $sort