Commercetools\Api\Models\Product\Attribute Interface Reference

Inherits Commercetools\Base\JsonObject.

Inherited by Commercetools\Api\Models\Product\AttributeModel.

Public Member Functions
	getName ()
	getValue ()
	setName (?string $name)
	setValue ($value)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (?callable $callable=null)

Public Attributes
const	FIELD_NAME = 'name'
const	FIELD_VALUE = 'value'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (?stdClass $data=null)

Detailed Description

Definition at line 14 of file Attribute.php.

Member Function Documentation

getName()

Commercetools\Api\Models\Product\Attribute::getName

(

)

Name of the Attribute.

Returns

null|string

Implemented in Commercetools\Api\Models\Product\AttributeModel.

getValue()

Commercetools\Api\Models\Product\Attribute::getValue

(

)

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value objects, or the complete objects as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Nested Type Attributes, use the list of values of all Attributes of the nested Product as value.
• For Reference Type Attributes, use the Reference object as value.

Returns

null|mixed

Implemented in Commercetools\Api\Models\Product\AttributeModel.

setName()

Commercetools\Api\Models\Product\Attribute::setName

(

?string

$name

)

Parameters

?string

$name

Implemented in Commercetools\Api\Models\Product\AttributeModel.

setValue()

Commercetools\Api\Models\Product\Attribute::setValue

(

$value

)

Parameters

mixed

$value

Implemented in Commercetools\Api\Models\Product\AttributeModel.

Member Data Documentation

FIELD_NAME

const Commercetools\Api\Models\Product\Attribute::FIELD_NAME = 'name'

Definition at line 16 of file Attribute.php.

FIELD_VALUE

const Commercetools\Api\Models\Product\Attribute::FIELD_VALUE = 'value'

Definition at line 17 of file Attribute.php.

---

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

• lib/commercetools-api/src/Models/Product/Attribute.php