CatalogPricing ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\CatalogPricing » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 5.0.0
Catalog Pricing service.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
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. |
| afterSavePurchasableHandler() | |
| areCatalogPricingJobsRunning() | |
| 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. |
| className() | Returns the fully qualified name of this class. |
| clearCatalogPricingJob() | |
| createCatalogPricesQuery() | Returns rows of purchasable prices. |
| createCatalogPricingJob() | |
| createCatalogPricingQuery() | Creates query for catalog pricing. |
| 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. |
| generateCatalogPrices() | |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCatalogPrice() | Return the catalog price for a purchasable. |
| getCatalogPrices() | |
| getCatalogPricesByPurchasableId() | |
| getCatalogPricesPageInfo() | |
| 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. |
| markPricesAsUpdatePending() | |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| trigger() | Triggers an event. |
afterSavePurchasableHandler() ​
- Since
- 5.0.0
Arguments ​
$event(craft\events\ModelEvent)
Returns ​
void
Throws ​
areCatalogPricingJobsRunning() ​
Returns ​
clearCatalogPricingJob() ​
Arguments ​
$catalogPricingJob(craft\commerce\queue\jobs\CatalogPricing)
Returns ​
void
createCatalogPricesQuery() ​
- Since
- 5.1.0
Returns rows of purchasable prices.
Arguments ​
$userId(integer, null)$storeId(integer, string, null)$allPrices(boolean)$condition(craft\commerce\elements\conditions\purchasables\CatalogPricingCondition, null)
Returns ​
Throws ​
createCatalogPricingJob() ​
Arguments ​
Returns ​
void
Throws ​
createCatalogPricingQuery() ​
DEPRECATED
Deprecated in 5.1.0. Use createCatalogPricesQuery() instead.
Creates query for catalog pricing.
Arguments ​
$userId(integer, null)$storeId(integer, string, null)$isPromotionalPrice(boolean, null)$allPrices(boolean)$condition(craft\commerce\elements\conditions\purchasables\CatalogPricingCondition, null)
Returns ​
Throws ​
generateCatalogPrices() ​
Arguments ​
$purchasableIds(array, null)$catalogPricingRules(craft\commerce\models\CatalogPricingRule[], null)$showConsoleOutput(boolean)$queue(yii\queue\Queue, craft\queue\QueueInterface, null)
Returns ​
void
Throws ​
getCatalogPrice() ​
Return the catalog price for a purchasable.
Arguments ​
$purchasableId(integer)$storeId(integer, null)$userId(integer, null)$isPromotionalPrice(boolean)
Returns ​
Throws ​
getCatalogPrices() ​
Arguments ​
$storeId(integer)$conditionBuilder(craft\commerce\elements\conditions\purchasables\CatalogPricingCondition, null)$includeBasePrices(boolean)$searchText(string, null)$limit(integer, null)$offset(integer, null)
Returns ​
\Illuminate\Support\Collection
Throws ​
getCatalogPricesByPurchasableId() ​
Arguments ​
Returns ​
\Illuminate\Support\Collection<\craft\commerce\models\CatalogPricing>
Throws ​
getCatalogPricesPageInfo() ​
Arguments ​
$storeId$conditionBuilder$includeBasePrices$searchText$limit$offset
markPricesAsUpdatePending() ​
Arguments ​
$catalogPricingRuleId(integer, array, null)$purchasableId(integer, array, null)$storeId(integer, array, null)
Returns ​
void