CatalogPricingRules ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\CatalogPricingRules » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 5.0.0
Catalog Pricing Rules service.
Public Properties ​
| Property | Description |
|---|---|
| allActiveCatalogPricingRules | craft\commerce\models\CatalogPricingRule[] |
| allCatalogPricingRules | craft\commerce\models\CatalogPricingRule[] |
| allCatalogPricingRulesWithUserConditions | \Illuminate\Support\Collection |
| allEnabledCatalogPricingRules | craft\commerce\models\CatalogPricingRule[], null |
| allPricingCatalogRules | craft\commerce\models\CatalogPricingRule[] |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
allActiveCatalogPricingRules ​
- Type
- craft\commerce\models\CatalogPricingRule[]
- Default value
null
allCatalogPricingRules ​
- Type
- craft\commerce\models\CatalogPricingRule[]
- Default value
null
allCatalogPricingRulesWithUserConditions ​
- Type
\Illuminate\Support\Collection- Default value
null- Access
- Read-only
allEnabledCatalogPricingRules ​
- Type
- craft\commerce\models\CatalogPricingRule[], null
- Default value
null
allPricingCatalogRules ​
- Type
- craft\commerce\models\CatalogPricingRule[]
- Default value
null
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| afterSaveUserHandler() | |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| canUseCatalogPricingRules() | |
| className() | Returns the fully qualified name of this class. |
| deleteCatalogPricingRuleById() | Delete a catalog pricing rule by its id. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| generateRulePriceFromPrice() | |
| getAllActiveCatalogPricingRules() | |
| getAllCatalogPricingRules() | Get all catalog pricing rules. |
| getAllCatalogPricingRulesByPurchasableId() | |
| getAllCatalogPricingRulesWithUserConditions() | |
| getAllEnabledCatalogPricingRules() | |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCatalogPricingRuleById() | Get a catalog pricing rule by its ID. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| saveCatalogPricingRule() | Save a Catalog Pricing Rule. |
| trigger() | Triggers an event. |
afterSaveUserHandler() ​
Arguments ​
$event(craft\events\ModelEvent)
Returns ​
void
Throws ​
canUseCatalogPricingRules() ​
Returns ​
Throws ​
deleteCatalogPricingRuleById() ​
Delete a catalog pricing rule by its id.
Arguments ​
$id(integer)
Returns ​
Throws ​
generateRulePriceFromPrice() ​
Arguments ​
$basePrice(float, null)$basePromotionalPrice(float, null)$catalogPricingRule(craft\commerce\models\CatalogPricingRule)
Returns ​
getAllActiveCatalogPricingRules() ​
Arguments ​
Returns ​
\Illuminate\Support\Collection<\craft\commerce\models\CatalogPricingRule>
Throws ​
getAllCatalogPricingRules() ​
Get all catalog pricing rules.
Arguments ​
Returns ​
\Illuminate\Support\Collection<\craft\commerce\models\CatalogPricingRule>
Throws ​
getAllCatalogPricingRulesByPurchasableId() ​
Arguments ​
Returns ​
\Illuminate\Support\Collection
Throws ​
getAllCatalogPricingRulesWithUserConditions() ​
Arguments ​
Returns ​
\Illuminate\Support\Collection
Throws ​
getAllEnabledCatalogPricingRules() ​
Arguments ​
Returns ​
\Illuminate\Support\Collection
Throws ​
getCatalogPricingRuleById() ​
Get a catalog pricing rule by its ID.
Arguments ​
Returns ​
craft\commerce\models\CatalogPricingRule, null
Throws ​
saveCatalogPricingRule() ​
Save a Catalog Pricing Rule.
Arguments ​
$catalogPricingRule$runValidation(boolean) – Should we validate this before saving.
Throws ​
Protected Methods ​
| Method | Description |
|---|---|
| _clearCaches() | Clear memoization caches |
| _createCatalogPricingRuleModels() | Takes the results array from a _createCatalogPricingRuleQuery() call and creates a collection of CatalogPricingRule models. |
| _createCatalogPricingRuleQuery() |
_clearCaches() ​
Clear memoization caches
_createCatalogPricingRuleModels() ​
Takes the results array from a _createCatalogPricingRuleQuery() call and creates a collection of CatalogPricingRule models.
Arguments ​
$rows(array)
Returns ​
\Illuminate\Support\Collection