ProductTypes

Type: Class
Namespace: craft\commerce\services
Inherits: craft\commerce\services\ProductTypes » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 2.0

Product type service.

# Public Properties

Property	Description
allProductTypeIds	array (opens new window) – all of the product type IDs
allProductTypes	array (opens new window), craft\commerce\models\ProductType[] – all product types
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
creatableProductTypeIds	array (opens new window)
creatableProductTypes	array (opens new window)
editableProductTypeIds	array (opens new window) – all of the product type IDs that are editable by the current user
editableProductTypes	array (opens new window), craft\commerce\models\ProductType[] – all editable product types

# `allProductTypeIds`

Type: array (opens new window)
Default value: null

all of the product type IDs

View source (opens new window)

# `allProductTypes`

Type: array (opens new window), craft\commerce\models\ProductType[]
Default value: null

all product types

View source (opens new window)

# `creatableProductTypeIds`

Type: array (opens new window)
Default value: null
Access: Read-only

View source (opens new window)

# `creatableProductTypes`

Type: array (opens new window)
Default value: null
Access: Read-only

View source (opens new window)

# `editableProductTypeIds`

Type: array (opens new window)
Default value: null

all of the product type IDs that are editable by the current user

View source (opens new window)

# `editableProductTypes`

Type: array (opens new window), craft\commerce\models\ProductType[]
Default value: null

all editable product types

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
afterSaveSiteHandler()	Adds a new product type setting row when a Site is added to Craft.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
deleteProductTypeById()	Deletes a product type by its ID.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getAllProductTypeIds()	Returns all the product type IDs.
getAllProductTypes()	Returns all product types.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getCreatableProductTypeIds()	Returns all product type IDs that are creatable by the current user.
getCreatableProductTypes()	Returns all creatable product types.
getEditableProductTypeIds()	Returns all product type IDs that are editable by the current user.
getEditableProductTypes()	Returns all editable product types.
getProductTypeByHandle()	Returns a product type by its handle.
getProductTypeById()	Returns a product type by its ID.
getProductTypeByUid()	Returns a product type by its UID.
getProductTypeSites()	Returns an array of product type site settings for a product type by its ID.
getProductTypesByShippingCategoryId()	Returns all product types by a shipping category id.
getProductTypesByTaxCategoryId()	Returns all product types by a tax category id.
handleChangedProductType()	Handle a product type change.
handleDeletedProductType()	Handle a product type getting deleted.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasPermission()	Check if user has product type permission.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init() (opens new window)	Initializes the object.
isProductTypeTemplateValid()	Returns whether a product type’s products have URLs, and if the template path is valid.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
pruneDeletedField()
pruneDeletedSite()	Prune a deleted site from category group site settings.
saveProductType()	Saves a product type.
trigger() (opens new window)	Triggers an event.

# `afterSaveSiteHandler()`

Adds a new product type setting row when a Site is added to Craft.

View source (opens new window)

Arguments

$event (craft\events\SiteEvent (opens new window)) – The event that triggered this.

Throws

# `deleteProductTypeById()`

Deletes a product type by its ID.

View source (opens new window)

Arguments

$id (integer (opens new window)) – The product type's ID

Returns

boolean (opens new window) – Whether the product type was deleted successfully.

Throws

Throwable (opens new window)
if reasons

# `getAllProductTypeIds()`

Returns all the product type IDs.

View source (opens new window)

Returns

array (opens new window) – An array of all the product types’ IDs.

# `getAllProductTypes()`

Returns all product types.

View source (opens new window)

Returns

craft\commerce\models\ProductType[] – An array of all product types.

# `getCreatableProductTypeIds()`

Returns all product type IDs that are creatable by the current user.

View source (opens new window)

Returns

array (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `getCreatableProductTypes()`

Returns all creatable product types.

View source (opens new window)

Returns

array (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `getEditableProductTypeIds()`

Returns all product type IDs that are editable by the current user.

View source (opens new window)

Returns

array (opens new window) – An array of all the editable product types’ IDs.

# `getEditableProductTypes()`

Returns all editable product types.

View source (opens new window)

Returns

craft\commerce\models\ProductType[] – An array of all the editable product types.

# `getProductTypeByHandle()`

Returns a product type by its handle.

View source (opens new window)

Arguments

$handle (string (opens new window)) – The product type's handle.

Returns

craft\commerce\models\ProductType, null (opens new window) – The product type or null.

# `getProductTypeById()`

Returns a product type by its ID.

View source (opens new window)

Arguments

$productTypeId (integer (opens new window)) – The product type's ID

Returns

craft\commerce\models\ProductType, null (opens new window) – Either the product type or null

# `getProductTypeByUid()`

Returns a product type by its UID.

View source (opens new window)

Arguments

$uid (string (opens new window)) – The product type's UID

Returns

craft\commerce\models\ProductType, null (opens new window) – Either the product type or null

# `getProductTypeSites()`

Returns an array of product type site settings for a product type by its ID.

View source (opens new window)

Arguments

$productTypeId (integer (opens new window)) – The product type ID

Returns

array (opens new window) – The product type settings.

# `getProductTypesByShippingCategoryId()`

Returns all product types by a shipping category id.

View source (opens new window)

Arguments

$shippingCategoryId

# `getProductTypesByTaxCategoryId()`

Returns all product types by a tax category id.

View source (opens new window)

Arguments

$taxCategoryId

# `handleChangedProductType()`

Handle a product type change.

View source (opens new window)

Arguments

$event

Throws

Throwable (opens new window)
if reasons

# `handleDeletedProductType()`

Handle a product type getting deleted.

View source (opens new window)

Arguments

$event

Throws

Throwable (opens new window)
if reasons

# `hasPermission()`

Check if user has product type permission.

View source (opens new window)

Arguments

$user (craft\elements\User (opens new window))
$productType (craft\commerce\models\ProductType)
$checkPermissionName (string (opens new window), null (opens new window)) – Detailed product type permission.

Returns

boolean (opens new window)

# `isProductTypeTemplateValid()`

Returns whether a product type’s products have URLs, and if the template path is valid.

View source (opens new window)

Arguments

$productType (craft\commerce\models\ProductType) – The product for which to validate the template.
$siteId (integer (opens new window)) – The site for which to valid for

Returns

boolean (opens new window) – Whether the template is valid.

Throws

yii\base\Exception (opens new window)

# `pruneDeletedField()`

DEPRECATED

Deprecated in 3.4.17. Unused fields will be pruned automatically as field layouts are resaved.

View source (opens new window)

# `pruneDeletedSite()`

Prune a deleted site from category group site settings.

View source (opens new window)

Arguments

$event

# `saveProductType()`

Saves a product type.

View source (opens new window)

Arguments

$productType (craft\commerce\models\ProductType) – The product type model.
$runValidation (boolean (opens new window)) – If validation should be ran.

Returns

boolean (opens new window) – Whether the product type was saved successfully.

Throws

Throwable (opens new window)
if reasons

# Constants

Constant	Description
`CONFIG_PRODUCTTYPES_KEY`

# Events

# EVENT_AFTER_SAVE_PRODUCTTYPE

Type: craft\commerce\events\ProductTypeEvent

The event that is triggered after a product type has been saved.

use craft\commerce\events\ProductTypeEvent;
use craft\commerce\services\ProductTypes;
use craft\commerce\models\ProductType;
use yii\base\Event;

Event::on(
    ProductTypes::class,
    ProductTypes::EVENT_AFTER_SAVE_PRODUCTTYPE,
    function(ProductTypeEvent $event) {
        // @var ProductType|null $productType
        $productType = $event->productType;

        // Prepare some third party system for a new product type
        // ...
    }
);

# EVENT_BEFORE_SAVE_PRODUCTTYPE

Type: craft\commerce\events\ProductTypeEvent

The event that is triggered before a product type is saved.

use craft\commerce\events\ProductTypeEvent;
use craft\commerce\services\ProductTypes;
use craft\commerce\models\ProductType;
use yii\base\Event;

Event::on(
    ProductTypes::class,
    ProductTypes::EVENT_BEFORE_SAVE_PRODUCTTYPE,
    function(ProductTypeEvent $event) {
        // @var ProductType|null $productType
        $productType = $event->productType;

        // Create an audit trail of this action
        // ...
    }
);

← Plans Products →

ProductTypes

# Public Properties

# allProductTypeIds

# allProductTypes

# creatableProductTypeIds

# creatableProductTypes

# editableProductTypeIds

# editableProductTypes

# Public Methods

# afterSaveSiteHandler()

Arguments

Throws

# deleteProductTypeById()

Arguments

Returns

Throws

# getAllProductTypeIds()

Returns

# getAllProductTypes()

Returns

# getCreatableProductTypeIds()

Returns

Throws

# getCreatableProductTypes()

Returns

Throws

# getEditableProductTypeIds()

Returns

# getEditableProductTypes()

Returns

# getProductTypeByHandle()

Arguments

Returns

# getProductTypeById()

Arguments

Returns

# getProductTypeByUid()

Arguments

Returns

# getProductTypeSites()

Arguments

Returns

# getProductTypesByShippingCategoryId()

Arguments

# getProductTypesByTaxCategoryId()

Arguments

# handleChangedProductType()

Arguments

Throws

# handleDeletedProductType()

Arguments

Throws

# hasPermission()

Arguments

Returns

# isProductTypeTemplateValid()

Arguments

Returns

Throws

# pruneDeletedField()

# pruneDeletedSite()

Arguments

# saveProductType()

Arguments

Returns

Throws

# Constants

# Events

# EVENT_AFTER_SAVE_PRODUCTTYPE

# EVENT_BEFORE_SAVE_PRODUCTTYPE

# `allProductTypeIds`

# `allProductTypes`

# `creatableProductTypeIds`

# `creatableProductTypes`

# `editableProductTypeIds`

# `editableProductTypes`

# `afterSaveSiteHandler()`

# `deleteProductTypeById()`

# `getAllProductTypeIds()`

# `getAllProductTypes()`

# `getCreatableProductTypeIds()`

# `getCreatableProductTypes()`

# `getEditableProductTypeIds()`

# `getEditableProductTypes()`

# `getProductTypeByHandle()`

# `getProductTypeById()`

# `getProductTypeByUid()`

# `getProductTypeSites()`

# `getProductTypesByShippingCategoryId()`

# `getProductTypesByTaxCategoryId()`

# `handleChangedProductType()`

# `handleDeletedProductType()`

# `hasPermission()`

# `isProductTypeTemplateValid()`

# `pruneDeletedField()`

# `pruneDeletedSite()`

# `saveProductType()`