Inheritance diagram for Option:

Public Member Functions
	addSelection (\Magento\Catalog\Model\Product $selection)

	isSaleable ()

	getDefaultSelection ()

	isMultiSelection ()

	getSearchableData ($productId, $storeId)

	getSelectionById ($selectionId)

	getOptionId ()

	getTitle ()

	getRequired ()

	getType ()

	getPosition ()

	getSku ()

	getProductLinks ()

	setOptionId ($optionId)

	setTitle ($title)

	setRequired ($required)

	setType ($type)

	setPosition ($position)

	setSku ($sku)

	setProductLinks (array $productLinks=null)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Bundle\Api\Data\OptionExtensionInterface $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)

Data Fields
const	KEY_OPTION_ID = 'option_id'

const	KEY_TITLE = 'title'

const	KEY_REQUIRED = 'required'

const	KEY_TYPE = 'type'

const	KEY_POSITION = 'position'

const	KEY_SKU = 'sku'

const	KEY_PRODUCT_LINKS = 'product_links'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Protected Member Functions
	_construct ()

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
	$defaultSelection = null

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 = []

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

Detailed Description

Bundle Option Model

@api @method int getParentId() @method null|\Magento\Catalog\Model\Product[] getSelections() @method Option setParentId(int $value)

Since: 100.0.2

Definition at line 17 of file Option.php.

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 40 of file Option.php.

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

◆ addSelection()

addSelection ( \Magento\Catalog\Model\Product $selection )

Add selection to option

Parameters

\Magento\Catalog\Model\Product $selection

Returns: void

Definition at line 52 of file Option.php.

     {
         if (!$this->hasData('selections')) {
             $this->setData('selections', []);
         }
         $selections = $this->getData('selections');
         $selections[] = $selection;
         $this->setSelections($selections);
     }

◆ getDefaultSelection()

getDefaultSelection ( )

Retrieve default Selection object

Returns: \Magento\Catalog\Model\Product|null

Definition at line 87 of file Option.php.

     {
         if (!$this->defaultSelection && $this->getSelections()) {
             foreach ($this->getSelections() as $selection) {
                 if ($selection->getIsDefault()) {
                     $this->defaultSelection = $selection;
                     break;
                 }
             }
         }
         return $this->defaultSelection;
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

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

Returns: \Magento\Bundle\Api\Data\OptionExtensionInterface|null

}

Returns: \Magento\Bundle\Api\Data\OptionExtensionInterface|null

Implements OptionInterface.

Definition at line 280 of file Option.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getOptionId()

getOptionId ( )

{Get option id

Returns: int|null

}

Implements OptionInterface.

Definition at line 145 of file Option.php.

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

◆ getPosition()

getPosition ( )

{Get option position

Returns: int|null

}

Implements OptionInterface.

Definition at line 177 of file Option.php.

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

◆ getProductLinks()

getProductLinks ( )

{Get product links

Returns: \Magento\Bundle\Api\Data\LinkInterface[]|null

}

Implements OptionInterface.

Definition at line 193 of file Option.php.

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

◆ getRequired()

getRequired ( )

{Get is required option

Returns: bool|null

}

Implements OptionInterface.

Definition at line 161 of file Option.php.

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

◆ getSearchableData()

getSearchableData	(	$productId,
		$storeId
	)

Retrieve options searchable data

Parameters

int	$productId
int	$storeId

Returns: array

Definition at line 117 of file Option.php.

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

◆ getSelectionById()

getSelectionById ( $selectionId )

Return selection by it's id

Parameters

int $selectionId

Returns: \Magento\Catalog\Model\Product|null

Definition at line 128 of file Option.php.

     {
         $foundSelection = null;
         foreach ($this->getSelections() as $selection) {
             if ($selection->getSelectionId() == $selectionId) {
                 $foundSelection = $selection;
                 break;
             }
         }
         return $foundSelection;
     }

◆ getSku()

getSku ( )

{Get product sku

Returns: string|null

}

Implements OptionInterface.

Definition at line 185 of file Option.php.

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

◆ getTitle()

getTitle ( )

{Get option title

Returns: string|null

}

Implements OptionInterface.

Definition at line 153 of file Option.php.

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

◆ getType()

getType ( )

{Get input type

Returns: string|null

}

Implements OptionInterface.

Definition at line 169 of file Option.php.

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

◆ isMultiSelection()

isMultiSelection ( )

Check is multi Option selection

Returns: bool

Definition at line 105 of file Option.php.

     {
         return $this->getType() == 'checkbox' || $this->getType() == 'multi';
     }

◆ isSaleable()

isSaleable ( )

Check Is Saleable Option

Returns: bool

Definition at line 67 of file Option.php.

     {
         $saleable = false;
         $selections = $this->getSelections();
         if ($selections) {
             foreach ($selections as $selection) {
                 if ($selection->isSaleable()) {
                     $saleable = true;
                     break;
                 }
             }
         }
         return $saleable;
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Bundle\Api\Data\OptionExtensionInterface $extensionAttributes )

{Set an extension attributes object.

Parameters

\Magento\Bundle\Api\Data\OptionExtensionInterface $extensionAttributes

Returns: $this

}

Parameters

\Magento\Bundle\Api\Data\OptionExtensionInterface $extensionAttributes

Returns: $this

Implements OptionInterface.

Definition at line 291 of file Option.php.

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

◆ setOptionId()

setOptionId ( $optionId )

Set option id

Parameters

int $optionId

Returns: $this

Implements OptionInterface.

Definition at line 204 of file Option.php.

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

◆ setPosition()

setPosition ( $position )

Set option position

Parameters

int $position

Returns: $this

Implements OptionInterface.

Definition at line 248 of file Option.php.

     {
         return $this->setData(self::KEY_POSITION, $position);
     }

◆ setProductLinks()

setProductLinks ( array $productLinks = null )

Set product links

Parameters

Implements OptionInterface.

Definition at line 270 of file Option.php.

     {
         return $this->setData(self::KEY_PRODUCT_LINKS, $productLinks);
     }

◆ setRequired()

setRequired ( $required )

Set whether option is required

Parameters

bool $required

Returns: $this

Implements OptionInterface.

Definition at line 226 of file Option.php.

     {
         return $this->setData(self::KEY_REQUIRED, $required);
     }

◆ setSku()

setSku ( $sku )

Set product sku

Parameters

string $sku

Returns: $this

Implements OptionInterface.

Definition at line 259 of file Option.php.

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

◆ setTitle()

setTitle ( $title )

Set option title

Parameters

string $title

Returns: $this

Implements OptionInterface.

Definition at line 215 of file Option.php.

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

◆ setType()

setType ( $type )

Set input type

Parameters

string $type

Returns: $this

Implements OptionInterface.

Definition at line 237 of file Option.php.

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

Field Documentation

◆ $defaultSelection

$defaultSelection = null

protected

#- #-

Definition at line 33 of file Option.php.

◆ KEY_OPTION_ID

const KEY_OPTION_ID = 'option_id'

#+ Constants

Definition at line 23 of file Option.php.

◆ KEY_POSITION

const KEY_POSITION = 'position'

Definition at line 27 of file Option.php.

◆ KEY_PRODUCT_LINKS

const KEY_PRODUCT_LINKS = 'product_links'

Definition at line 29 of file Option.php.

◆ KEY_REQUIRED

const KEY_REQUIRED = 'required'

Definition at line 25 of file Option.php.

◆ KEY_SKU

const KEY_SKU = 'sku'

Definition at line 28 of file Option.php.

◆ KEY_TITLE

const KEY_TITLE = 'title'

Definition at line 24 of file Option.php.

◆ KEY_TYPE

const KEY_TYPE = 'type'

Definition at line 26 of file Option.php.

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

vendor/magento/module-bundle/Model/Option.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _construct()

◆ addSelection()

◆ getDefaultSelection()

◆ getExtensionAttributes()

◆ getOptionId()

◆ getPosition()

◆ getProductLinks()

◆ getRequired()

◆ getSearchableData()

◆ getSelectionById()

◆ getSku()

◆ getTitle()

◆ getType()

◆ isMultiSelection()

◆ isSaleable()

◆ setExtensionAttributes()

◆ setOptionId()

◆ setPosition()

◆ setProductLinks()

◆ setRequired()

◆ setSku()

◆ setTitle()

◆ setType()

Field Documentation

◆ $defaultSelection

◆ KEY_OPTION_ID

◆ KEY_POSITION

◆ KEY_PRODUCT_LINKS

◆ KEY_REQUIRED

◆ KEY_SKU

◆ KEY_TITLE

◆ KEY_TYPE