Inheritance diagram for Option:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, Option\Value $productOptionValue, \Magento\Catalog\Model\Product\Option\Type\Factory $optionFactory, \Magento\Framework\Stdlib\StringUtils $string, Option\Validator\Pool $validatorPool, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], ProductCustomOptionValuesInterfaceFactory $customOptionValuesFactory=null)

	addValue (Option\Value $value)

	getValueById ($valueId)

	hasValues ($type=null)

	getValues ()

	getValueInstance ()

	addOption ($option)

	getOptions ()

	setOptions ($options)

	unsetOptions ()

	getProduct ()

	setProduct (Product $product=null)

	getGroupByType ($type=null)

	groupFactory ($type)

	beforeSave ()

	afterSave ()

	getPrice ($flag=false)

	deletePrices ($optionId)

	deleteTitles ($optionId)

	getProductOptions (Product $product)

	getValuesCollection ()

	getOptionValuesByOptionId ($optionIds, $storeId)

	duplicate ($oldProductId, $newProductId)

	getSearchableData ($productId, $storeId)

	getProductSku ()

	getOptionId ()

	getTitle ()

	getType ()

	getSortOrder ()

	getIsRequire ()

	getPriceType ()

	getSku ()

	getFileExtension ()

	getMaxCharacters ()

	getImageSizeX ()

	getImageSizeY ()

	setProductSku ($productSku)

	setOptionId ($optionId)

	setTitle ($title)

	setType ($type)

	setSortOrder ($sortOrder)

	setIsRequire ($isRequired)

	setPrice ($price)

	setPriceType ($priceType)

	setSku ($sku)

	setFileExtension ($fileExtension)

	setMaxCharacters ($maxCharacters)

	setImageSizeX ($imageSizeX)

	setImageSizeY ($imageSizeY)

	setValues (array $values=null)

	getExtensionAttributes ()

	getRegularPrice ()

	getProductOptionCollection (Product $product)

	setExtensionAttributes (\Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface $extensionAttributes)

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from ProductCustomOptionInterface
	getPrice ()

Data Fields
const	KEY_PRODUCT_SKU = 'product_sku'

const	KEY_OPTION_ID = 'option_id'

const	KEY_TITLE = 'title'

const	KEY_TYPE = 'type'

const	KEY_SORT_ORDER = 'sort_order'

const	KEY_IS_REQUIRE = 'is_require'

const	KEY_PRICE = 'price'

const	KEY_PRICE_TYPE = 'price_type'

const	KEY_SKU = 'sku'

const	KEY_FILE_EXTENSION = 'file_extension'

const	KEY_MAX_CHARACTERS = 'max_characters'

const	KEY_IMAGE_SIZE_Y = 'image_size_y'

const	KEY_IMAGE_SIZE_X = 'image_size_x'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from ProductCustomOptionInterface
const	OPTION_GROUP_TEXT = 'text'

const	OPTION_GROUP_FILE = 'file'

const	OPTION_GROUP_SELECT = 'select'

const	OPTION_GROUP_DATE = 'date'

const	OPTION_TYPE_FIELD = 'field'

const	OPTION_TYPE_AREA = 'area'

const	OPTION_TYPE_FILE = 'file'

const	OPTION_TYPE_DROP_DOWN = 'drop_down'

const	OPTION_TYPE_RADIO = 'radio'

const	OPTION_TYPE_CHECKBOX = 'checkbox'

const	OPTION_TYPE_MULTIPLE = 'multiple'

const	OPTION_TYPE_DATE = 'date'

const	OPTION_TYPE_DATE_TIME = 'date_time'

const	OPTION_TYPE_TIME = 'time'

Protected Member Functions
	_getResource ()

	_construct ()

	_clearData ()

	_clearReferences ()

	_getValidationRulesBeforeSave ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$optionRepository

	$product

	$options = []

	$values = null

	$productOptionValue

	$optionTypeFactory

	$string

	$validatorPool

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$typePercent = 'percent'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Catalog product option model

@api @method int getProductId() @method \Magento\Catalog\Model\Product\Option setProductId(int $value)

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.ExcessivePublicCount)

Since: 100.0.2

Definition at line 32 of file Option.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory,
		Option\Value	$productOptionValue,
		\Magento\Catalog\Model\Product\Option\Type\Factory	$optionFactory,
		\Magento\Framework\Stdlib\StringUtils	$string,
		Option\Validator\Pool	$validatorPool,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		ProductCustomOptionValuesInterfaceFactory	$customOptionValuesFactory = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory
Option\Value	$productOptionValue
Option\Type\Factory	$optionFactory
\Magento\Framework\Stdlib\StringUtils	$string
Option\Validator\Pool	$validatorPool
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
ProductCustomOptionValuesInterfaceFactory \| null	$customOptionValuesFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 126 of file Option.php.

       {
         $this->productOptionValue = $productOptionValue;
         $this->optionTypeFactory = $optionFactory;
         $this->validatorPool = $validatorPool;
         $this->string = $string;
         $this->customOptionValuesFactory = $customOptionValuesFactory ?:
             \Magento\Framework\App\ObjectManager::getInstance()->get(ProductCustomOptionValuesInterfaceFactory::class);
 
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _clearData()

_clearData ( )

protected

Clearing object's data

Returns: $this

Definition at line 535 of file Option.php.

     {
         $this->_data = [];
         $this->values = null;
         return $this;
     }

◆ _clearReferences()

_clearReferences ( )

protected

Clearing cyclic references

Returns: $this

Definition at line 547 of file Option.php.

     {
         if (!empty($this->values)) {
             foreach ($this->values as $value) {
                 $value->unsetOption();
             }
         }
         return $this;
     }

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 172 of file Option.php.

     {
         $this->_init(\Magento\Catalog\Model\ResourceModel\Product\Option::class);
         parent::_construct();
     }

◆ _getResource()

_getResource ( )

protected

Get resource instance

Returns: \Magento\Framework\Model\ResourceModel\Db\AbstractDb

Deprecated:: 102.0.0 because resource models should be used directly

Definition at line 164 of file Option.php.

     {
         return $this->_resource ?: parent::_getResource();
     }

◆ _getValidationRulesBeforeSave()

_getValidationRulesBeforeSave ( )

protected

{}

Definition at line 560 of file Option.php.

     {
         return $this->validatorPool->get($this->getType());
     }

◆ addOption()

addOption ( $option )

Add option for save it

Parameters

array $option

Returns: $this

Definition at line 241 of file Option.php.

     {
         $this->options[] = $option;
         return $this;
     }

◆ addValue()

addValue ( Option\Value $value )

Add value of option to values array

Parameters

Option\Value $value

Returns: $this

Definition at line 184 of file Option.php.

     {
         $this->values[$value->getId()] = $value;
         return $this;
     }

◆ afterSave()

afterSave ( )

Returns: \Magento\Framework\Model\AbstractModel

Exceptions

Definition at line 402 of file Option.php.

     {
         $values = $this->getValues() ?: $this->getData('values');
         if (is_array($values)) {
             foreach ($values as $value) {
                 if ($value instanceof ProductCustomOptionValuesInterface) {
                     $data = $value->getData();
                 } else {
                     $data = $value;
                 }
 
                 $this->customOptionValuesFactory->create()
                     ->addValue($data)
                     ->setOption($this)
                     ->saveValues();
             }
         } elseif ($this->getGroupByType($this->getType()) === self::OPTION_GROUP_SELECT) {
             throw new LocalizedException(__('Select type options required values rows.'));
         }
 
         return parent::afterSave();
     }

◆ beforeSave()

beforeSave ( )

{} @SuppressWarnings(PHPMD.CyclomaticComplexity)

Since: 101.0.0

if previous option has different group from one is came now need to remove all data of previous group

Definition at line 352 of file Option.php.

     {
         parent::beforeSave();
         if ($this->getData('previous_type') != '') {
             $previousType = $this->getData('previous_type');
 
             if ($this->getGroupByType($previousType) != $this->getGroupByType($this->getData('type'))) {
                 switch ($this->getGroupByType($previousType)) {
                     case self::OPTION_GROUP_SELECT:
                         $this->unsetData('values');
                         if ($this->getId()) {
                             $this->getValueInstance()->deleteValue($this->getId());
                         }
                         break;
                     case self::OPTION_GROUP_FILE:
                         $this->setData('file_extension', '');
                         $this->setData('image_size_x', '0');
                         $this->setData('image_size_y', '0');
                         break;
                     case self::OPTION_GROUP_TEXT:
                         $this->setData('max_characters', '0');
                         break;
                     case self::OPTION_GROUP_DATE:
                         break;
                 }
                 if ($this->getGroupByType($this->getData('type')) == self::OPTION_GROUP_SELECT) {
                     $this->setData('sku', '');
                     $this->unsetData('price');
                     $this->unsetData('price_type');
                     if ($this->getId()) {
                         $this->deletePrices($this->getId());
                     }
                 }
             }
         }
         if ($this->getGroupByType($this->getData('type')) === self::OPTION_GROUP_FILE) {
             $this->cleanFileExtensions();
         }
 
         return $this;
     }

◆ deletePrices()

deletePrices ( $optionId )

Delete prices of option

Parameters

int $optionId

Returns: $this

Definition at line 448 of file Option.php.

     {
         $this->getResource()->deletePrices($optionId);
         return $this;
     }

◆ deleteTitles()

deleteTitles ( $optionId )

Delete titles of option

Parameters

int $optionId

Returns: $this

Definition at line 460 of file Option.php.

     {
         $this->getResource()->deleteTitles($optionId);
         return $this;
     }

◆ duplicate()

duplicate	(	$oldProductId,
		$newProductId
	)

Duplicate options for product

Parameters

int	$oldProductId
int	$newProductId

Returns: $this

Definition at line 511 of file Option.php.

     {
         $this->getResource()->duplicate($this, $oldProductId, $newProductId);
 
         return $this;
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface|null

}

Returns: \Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface|null

Implements ProductCustomOptionInterface.

Definition at line 833 of file Option.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getFileExtension()

getFileExtension ( )

Returns: string|null

Implements ProductCustomOptionInterface.

Definition at line 654 of file Option.php.

     {
         return $this->getData(self::KEY_FILE_EXTENSION);
     }

◆ getGroupByType()

getGroupByType ( $type = null )

Get group name of option by given option type

Parameters

string $type

Returns: string

Definition at line 308 of file Option.php.

     {
         if ($type === null) {
             $type = $this->getType();
         }
         $optionGroupsToTypes = [
             self::OPTION_TYPE_FIELD => self::OPTION_GROUP_TEXT,
             self::OPTION_TYPE_AREA => self::OPTION_GROUP_TEXT,
             self::OPTION_TYPE_FILE => self::OPTION_GROUP_FILE,
             self::OPTION_TYPE_DROP_DOWN => self::OPTION_GROUP_SELECT,
             self::OPTION_TYPE_RADIO => self::OPTION_GROUP_SELECT,
             self::OPTION_TYPE_CHECKBOX => self::OPTION_GROUP_SELECT,
             self::OPTION_TYPE_MULTIPLE => self::OPTION_GROUP_SELECT,
             self::OPTION_TYPE_DATE => self::OPTION_GROUP_DATE,
             self::OPTION_TYPE_DATE_TIME => self::OPTION_GROUP_DATE,
             self::OPTION_TYPE_TIME => self::OPTION_GROUP_DATE,
         ];
 
         return $optionGroupsToTypes[$type] ?? '';
     }

◆ getImageSizeX()

getImageSizeX ( )

Returns: int|null

Implements ProductCustomOptionInterface.

Definition at line 670 of file Option.php.

     {
         return $this->getData(self::KEY_IMAGE_SIZE_X);
     }

◆ getImageSizeY()

getImageSizeY ( )

Returns: int|null

Implements ProductCustomOptionInterface.

Definition at line 678 of file Option.php.

     {
         return $this->getData(self::KEY_IMAGE_SIZE_Y);
     }

◆ getIsRequire()

getIsRequire ( )

Get is require

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements ProductCustomOptionInterface.

Definition at line 626 of file Option.php.

     {
         return $this->_getData(self::KEY_IS_REQUIRE);
     }

◆ getMaxCharacters()

getMaxCharacters ( )

Returns: int|null

Implements ProductCustomOptionInterface.

Definition at line 662 of file Option.php.

     {
         return $this->getData(self::KEY_MAX_CHARACTERS);
     }

◆ getOptionId()

getOptionId ( )

Get option id

Returns: int|null @codeCoverageIgnoreStart

Implements ProductCustomOptionInterface.

Definition at line 585 of file Option.php.

     {
         return $this->_getData(self::KEY_OPTION_ID);
     }

◆ getOptions()

getOptions ( )

Get all options

Returns: array

Definition at line 252 of file Option.php.

     {
         return $this->options;
     }

◆ getOptionValuesByOptionId()

getOptionValuesByOptionId	(	$optionIds,
		$storeId
	)

Get collection of values by given option ids

Parameters

array	$optionIds
int	$storeId

Returns: Collection

Definition at line 497 of file Option.php.

     {
         $collection = $this->productOptionValue->getValuesByOption($optionIds, $this->getId(), $storeId);
 
         return $collection;
     }

◆ getPrice()

getPrice ( $flag = false )

Return price. If $flag is true and price is percent return converted percent to price

Parameters

bool $flag

Returns: float

Definition at line 432 of file Option.php.

     {
         if ($flag && $this->getPriceType() == self::$typePercent) {
             $basePrice = $this->getProduct()->getPriceInfo()->getPrice(BasePrice::PRICE_CODE)->getValue();
             $price = $basePrice * ($this->_getData(self::KEY_PRICE) / 100);
             return $price;
         }
         return $this->_getData(self::KEY_PRICE);
     }

◆ getPriceType()

getPriceType ( )

Get price type

Returns: string|null

Implements ProductCustomOptionInterface.

Definition at line 636 of file Option.php.

     {
         return $this->_getData(self::KEY_PRICE_TYPE);
     }

◆ getProduct()

getProduct ( )

Retrieve product instance

Returns: Product

Definition at line 285 of file Option.php.

     {
         return $this->product;
     }

◆ getProductOptionCollection()

getProductOptionCollection ( Product $product )

Parameters

Product $product

Returns: \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

Definition at line 858 of file Option.php.

     {
         $collection = clone $this->getCollection();
         $collection->addFieldToFilter(
             'product_id',
             $product->getData($this->getMetadataPool()->getMetadata(ProductInterface::class)->getLinkField())
         )->addTitleToResult(
             $product->getStoreId()
         )->addPriceToResult(
             $product->getStoreId()
         )->setOrder(
             'sort_order',
             'asc'
         )->setOrder(
             'title',
             'asc'
         );
 
         if ($this->getAddRequiredFilter()) {
             $collection->addRequiredFilter($this->getAddRequiredFilterValue());
         }
 
         $collection->addValuesToResult($product->getStoreId());
         return $collection;
     }

◆ getProductOptions()

getProductOptions ( Product $product )

Get Product Option Collection

Parameters

Product $product

Returns: \Magento\Catalog\Model\ResourceModel\Product\Option\Collection

Since: 101.0.0

Definition at line 473 of file Option.php.

     {
         return $this->getOptionRepository()->getProductOptions($product, $this->getAddRequiredFilter());
     }

◆ getProductSku()

getProductSku ( )

Get product SKU

Returns: string

Implements ProductCustomOptionInterface.

Definition at line 570 of file Option.php.

     {
         $productSku = $this->_getData(self::KEY_PRODUCT_SKU);
         if (!$productSku && $this->getProduct()) {
             $productSku = $this->getProduct()->getSku();
         }
         return $productSku;
     }

◆ getRegularPrice()

getRegularPrice ( )

Return regular price.

Returns: float|int

Since: 101.0.0

Definition at line 844 of file Option.php.

     {
         if ($this->getPriceType() == self::$typePercent) {
             $basePrice = $this->getProduct()->getPriceInfo()->getPrice('regular_price')->getAmount()->getValue();
             $price = $basePrice * ($this->_getData(self::KEY_PRICE) / 100);
             return $price;
         }
         return $this->_getData(self::KEY_PRICE);
     }

◆ getSearchableData()

getSearchableData	(	$productId,
		$storeId
	)

Retrieve option searchable data

Parameters

int	$productId
int	$storeId

Returns: array

Definition at line 525 of file Option.php.

     {
         return $this->_getResource()->getSearchableData($productId, $storeId);
     }

◆ getSku()

getSku ( )

Get Sku

Returns: string|null

Implements ProductCustomOptionInterface.

Definition at line 646 of file Option.php.

     {
         return $this->_getData(self::KEY_SKU);
     }

◆ getSortOrder()

getSortOrder ( )

Get sort order

Returns: int

Implements ProductCustomOptionInterface.

Definition at line 615 of file Option.php.

     {
         return $this->_getData(self::KEY_SORT_ORDER);
     }

◆ getTitle()

getTitle ( )

Get option title

Returns: string

Implements ProductCustomOptionInterface.

Definition at line 595 of file Option.php.

     {
         return $this->_getData(self::KEY_TITLE);
     }

◆ getType()

getType ( )

Get option type

Returns: string

Implements ProductCustomOptionInterface.

Definition at line 605 of file Option.php.

     {
         return $this->_getData(self::KEY_TYPE);
     }

◆ getValueById()

getValueById ( $valueId )

Get value by given id

Parameters

int $valueId

Returns: Option\Value|null

Definition at line 196 of file Option.php.

     {
         if (isset($this->values[$valueId])) {
             return $this->values[$valueId];
         }
 
         return null;
     }

◆ getValueInstance()

getValueInstance ( )

Retrieve value instance

Returns: Option\Value

Definition at line 230 of file Option.php.

     {
         return $this->productOptionValue;
     }

◆ getValues()

getValues ( )

Returns: ProductCustomOptionValuesInterface[]|null

Implements ProductCustomOptionInterface.

Definition at line 220 of file Option.php.

     {
         return $this->values;
     }

◆ getValuesCollection()

getValuesCollection ( )

Get collection of values for current option

Returns: Collection

Definition at line 483 of file Option.php.

     {
         $collection = $this->getValueInstance()->getValuesCollection($this);
 
         return $collection;
     }

◆ groupFactory()

groupFactory ( $type )

Group model factory

Parameters

string $type Option type

Returns: \Magento\Catalog\Model\Product\Option\Type\DefaultType

Exceptions

LocalizedException

Definition at line 336 of file Option.php.

     {
         $group = $this->getGroupByType($type);
         if (!empty($group)) {
             return $this->optionTypeFactory->create(
                 'Magento\Catalog\Model\Product\Option\Type\\' . $this->string->upperCaseWords($group)
             );
         }
         throw new LocalizedException(__('The option type to get group instance is incorrect.'));
     }

◆ hasValues()

hasValues ( $type = null )

Whether or not the option type contains sub-values

Parameters

string $type

Returns: bool

Since: 102.0.0

Definition at line 212 of file Option.php.

     {
         return $this->getGroupByType($type) == self::OPTION_GROUP_SELECT;
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface $extensionAttributes )

{Set an extension attributes object.

Parameters

\Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface $extensionAttributes

Returns: $this

}

Parameters

\Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface $extensionAttributes

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 890 of file Option.php.

       {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

◆ setFileExtension()

setFileExtension ( $fileExtension )

Parameters

string $fileExtension

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 786 of file Option.php.

     {
         return $this->setData(self::KEY_FILE_EXTENSION, $fileExtension);
     }

◆ setImageSizeX()

setImageSizeX ( $imageSizeX )

Parameters

int $imageSizeX

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 804 of file Option.php.

     {
         return $this->setData(self::KEY_IMAGE_SIZE_X, $imageSizeX);
     }

◆ setImageSizeY()

setImageSizeY ( $imageSizeY )

Parameters

int $imageSizeY

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 813 of file Option.php.

     {
         return $this->setData(self::KEY_IMAGE_SIZE_Y, $imageSizeY);
     }

◆ setIsRequire()

setIsRequire ( $isRequired )

Set is require

Parameters

bool $isRequired

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 744 of file Option.php.

     {
         return $this->setData(self::KEY_IS_REQUIRE, $isRequired);
     }

◆ setMaxCharacters()

setMaxCharacters ( $maxCharacters )

Parameters

int $maxCharacters

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 795 of file Option.php.

     {
         return $this->setData(self::KEY_MAX_CHARACTERS, $maxCharacters);
     }

◆ setOptionId()

setOptionId ( $optionId )

Set option id

Parameters

int $optionId

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 700 of file Option.php.

     {
         return $this->setData(self::KEY_OPTION_ID, $optionId);
     }

◆ setOptions()

setOptions ( $options )

Set options for array

Parameters

array $options

Returns: $this

Definition at line 263 of file Option.php.

     {
         $this->options = $options;
         return $this;
     }

◆ setPrice()

setPrice ( $price )

Set price

Parameters

float $price

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 755 of file Option.php.

     {
         return $this->setData(self::KEY_PRICE, $price);
     }

◆ setPriceType()

setPriceType ( $priceType )

Set price type

Parameters

string $priceType

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 766 of file Option.php.

     {
         return $this->setData(self::KEY_PRICE_TYPE, $priceType);
     }

◆ setProduct()

setProduct ( Product $product = null )

Set product instance

Parameters

Product $product

Returns: $this

Definition at line 296 of file Option.php.

     {
         $this->product = $product;
         return $this;
     }

◆ setProductSku()

setProductSku ( $productSku )

Set product SKU

Parameters

string $productSku

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 689 of file Option.php.

     {
         return $this->setData(self::KEY_PRODUCT_SKU, $productSku);
     }

◆ setSku()

setSku ( $sku )

Set Sku

Parameters

string $sku

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 777 of file Option.php.

     {
         return $this->setData(self::KEY_SKU, $sku);
     }

◆ setSortOrder()

setSortOrder ( $sortOrder )

Set sort order

Parameters

int $sortOrder

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 733 of file Option.php.

     {
         return $this->setData(self::KEY_SORT_ORDER, $sortOrder);
     }

◆ setTitle()

setTitle ( $title )

Set option title

Parameters

string $title

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 711 of file Option.php.

     {
         return $this->setData(self::KEY_TITLE, $title);
     }

◆ setType()

setType ( $type )

Set option type

Parameters

string $type

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 722 of file Option.php.

     {
         return $this->setData(self::KEY_TYPE, $type);
     }

◆ setValues()

setValues ( array $values = null )

Parameters

ProductCustomOptionValuesInterface[] $values

Returns: $this

Implements ProductCustomOptionInterface.

Definition at line 822 of file Option.php.

     {
         $this->values = $values;
         return $this;
     }

◆ unsetOptions()

unsetOptions ( )

Set options to empty array

Returns: $this

Definition at line 274 of file Option.php.

     {
         $this->options = [];
         return $this;
     }

Field Documentation

◆ $optionRepository

$optionRepository

protected

Definition at line 38 of file Option.php.

◆ $options

$options = []

protected

Definition at line 70 of file Option.php.

◆ $optionTypeFactory

$optionTypeFactory

protected

Definition at line 89 of file Option.php.

◆ $product

$product

protected

#- #-

Definition at line 65 of file Option.php.

◆ $productOptionValue

$productOptionValue

protected

Definition at line 82 of file Option.php.

◆ $string

$string

protected

Definition at line 94 of file Option.php.

◆ $typePercent

$typePercent = 'percent'

staticprotected

Option type percent

Since: 101.0.0

Definition at line 44 of file Option.php.

◆ $validatorPool

$validatorPool

protected

Definition at line 99 of file Option.php.

◆ $values

$values = null

protected

Definition at line 75 of file Option.php.

◆ KEY_FILE_EXTENSION

const KEY_FILE_EXTENSION = 'file_extension'

Definition at line 58 of file Option.php.

◆ KEY_IMAGE_SIZE_X

const KEY_IMAGE_SIZE_X = 'image_size_x'

Definition at line 61 of file Option.php.

◆ KEY_IMAGE_SIZE_Y

const KEY_IMAGE_SIZE_Y = 'image_size_y'

Definition at line 60 of file Option.php.

◆ KEY_IS_REQUIRE

const KEY_IS_REQUIRE = 'is_require'

Definition at line 54 of file Option.php.

◆ KEY_MAX_CHARACTERS

const KEY_MAX_CHARACTERS = 'max_characters'

Definition at line 59 of file Option.php.

◆ KEY_OPTION_ID

const KEY_OPTION_ID = 'option_id'

Definition at line 50 of file Option.php.

◆ KEY_PRICE

const KEY_PRICE = 'price'

Definition at line 55 of file Option.php.

◆ KEY_PRICE_TYPE

const KEY_PRICE_TYPE = 'price_type'

Definition at line 56 of file Option.php.

◆ KEY_PRODUCT_SKU

const KEY_PRODUCT_SKU = 'product_sku'

#+ Constants

Definition at line 49 of file Option.php.

◆ KEY_SKU

const KEY_SKU = 'sku'

Definition at line 57 of file Option.php.

◆ KEY_SORT_ORDER

const KEY_SORT_ORDER = 'sort_order'

Definition at line 53 of file Option.php.

◆ KEY_TITLE

const KEY_TITLE = 'title'

Definition at line 51 of file Option.php.

◆ KEY_TYPE

const KEY_TYPE = 'type'

Definition at line 52 of file Option.php.

The documentation for this class was generated from the following file:

vendor/magento/module-catalog/Model/Product/Option.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _clearData()

◆ _clearReferences()

◆ _construct()

◆ _getResource()

◆ _getValidationRulesBeforeSave()

◆ addOption()

◆ addValue()

◆ afterSave()

◆ beforeSave()

◆ deletePrices()

◆ deleteTitles()

◆ duplicate()

◆ getExtensionAttributes()

◆ getFileExtension()

◆ getGroupByType()

◆ getImageSizeX()

◆ getImageSizeY()

◆ getIsRequire()

◆ getMaxCharacters()

◆ getOptionId()

◆ getOptions()

◆ getOptionValuesByOptionId()

◆ getPrice()

◆ getPriceType()

◆ getProduct()

◆ getProductOptionCollection()

◆ getProductOptions()

◆ getProductSku()

◆ getRegularPrice()

◆ getSearchableData()

◆ getSku()

◆ getSortOrder()

◆ getTitle()

◆ getType()

◆ getValueById()

◆ getValueInstance()

◆ getValues()

◆ getValuesCollection()

◆ groupFactory()

◆ hasValues()

◆ setExtensionAttributes()

◆ setFileExtension()

◆ setImageSizeX()

◆ setImageSizeY()

◆ setIsRequire()

◆ setMaxCharacters()

◆ setOptionId()

◆ setOptions()

◆ setPrice()

◆ setPriceType()

◆ setProduct()

◆ setProductSku()

◆ setSku()

◆ setSortOrder()

◆ setTitle()

◆ setType()

◆ setValues()

◆ unsetOptions()

Field Documentation

◆ $optionRepository

◆ $options

◆ $optionTypeFactory

◆ $product

◆ $productOptionValue

◆ $string

◆ $typePercent

◆ $validatorPool

◆ $values

◆ KEY_FILE_EXTENSION

◆ KEY_IMAGE_SIZE_X

◆ KEY_IMAGE_SIZE_Y