ModelDiscounts module

PersonCondition

Person condition describes the conditions that need to be met for the discount to be applied; based on specific emails.
The discount will only be applicable to the selected emails and can either allow or forbid the discount application.

A model in the Discounts module, with 18 members for templates, 15 API properties and 19 members for admin templates.

Discounts\Models\Frontend\PersonCondition Discounts\Models\Api\PersonCondition Discounts\Models\Backend\PersonCondition Also in Discounts: BaseAction CartAction CartCondition Code CodeUrl CodeUrlProduct CountryCondition DateCondition Discount Log MaxUsageCondition OrderCondition PersonGroupCondition ProductAction ProductCategoryCondition ProductCondition Rule ShippingAction TemplateCondition
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 18

Take no arguments.

# getPersonIds()
array
Gets the person IDs for this condition.
# getAction()
?string
Gets the action type for this condition (allow or forbid).
# isAllowed()
bool
Checks if the action is allowed for the current condition
# isForbidden()
bool
Checks if the action is forbidden for the current condition
# getDisplayType()
string
Returns the nice name of a condition type
# getType()
string
Returns the type of condition
# getSnakeType()
string
Returns the type of condition in the snake case format: lowercase and connected by underline
# getSlugType()
string
Returns the type of condition in the slug format: lowercase and connected by hyphen
# getId()
?int
# getName()
?string
# getData()
?array
# isActive()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getRule()
?Rule
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 15

Read-only values on the record.

# personIds
array
Gets the person IDs for this condition.
# action
?string
Gets the action type for this condition (allow or forbid).
# allowed
bool
Checks if the action is allowed for the current condition
# forbidden
bool
Checks if the action is forbidden for the current condition
# displayType
string
Returns the nice name of a condition type
# type
string
Returns the type of condition
# snakeType
string
Returns the type of condition in the snake case format: lowercase and connected by underline
# slugType
string
Returns the type of condition in the slug format: lowercase and connected by hyphen
# id
?int
# name
?string
# data
?array
# active
bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# rule
?Rule

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 19

Take no arguments.

# getPersonIds()
array
Gets the person IDs for this condition.
# getAction()
?string
Gets the action type for this condition (allow or forbid).
# isAllowed()
bool
Checks if the action is allowed for the current condition
# isForbidden()
bool
Checks if the action is forbidden for the current condition
# getDisplayType()
string
Returns the nice name of a condition type
# getType()
string
Returns the type of condition
# getSnakeType()
string
Returns the type of condition in the snake case format: lowercase and connected by underline
# getSlugType()
string
Returns the type of condition in the slug format: lowercase and connected by hyphen
# getId()
?int
# getName()
?string
# getData()
?array
# isActive()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getRule()
?Rule
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getIcon() Admin only
string
Returns the icon that represents the type