Commercetools\Api\Models\ProductType\AttributeDefinition Interface Reference

Inherits Commercetools\Base\JsonObject.

Inherited by Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

Public Member Functions
	getType ()
	getName ()
	getLabel ()
	getIsRequired ()
	getLevel ()
	getAttributeConstraint ()
	getInputTip ()
	getInputHint ()
	getIsSearchable ()
	setType (?AttributeType $type)
	setName (?string $name)
	setLabel (?LocalizedString $label)
	setIsRequired (?bool $isRequired)
	setLevel (?string $level)
	setAttributeConstraint (?string $attributeConstraint)
	setInputTip (?LocalizedString $inputTip)
	setInputHint (?string $inputHint)
	setIsSearchable (?bool $isSearchable)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (?callable $callable=null)

Public Attributes
const	FIELD_TYPE = 'type'
const	FIELD_NAME = 'name'
const	FIELD_LABEL = 'label'
const	FIELD_IS_REQUIRED = 'isRequired'
const	FIELD_LEVEL = 'level'
const	FIELD_ATTRIBUTE_CONSTRAINT = 'attributeConstraint'
const	FIELD_INPUT_TIP = 'inputTip'
const	FIELD_INPUT_HINT = 'inputHint'
const	FIELD_IS_SEARCHABLE = 'isSearchable'

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 15 of file AttributeDefinition.php.

Member Function Documentation

getAttributeConstraint()

Commercetools\Api\Models\ProductType\AttributeDefinition::getAttributeConstraint

(

)

Specifies how Attributes are validated across all variants of a Product.

Returns

null|string

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getInputHint()

Commercetools\Api\Models\ProductType\AttributeDefinition::getInputHint

(

)

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

Returns

null|string

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getInputTip()

Commercetools\Api\Models\ProductType\AttributeDefinition::getInputTip

(

)

Provides additional Attribute information to aid content managers configure Product details.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getIsRequired()

Commercetools\Api\Models\ProductType\AttributeDefinition::getIsRequired

(

)

If true, the Attribute must have a value on a ProductVariant.

Returns

null|bool

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getIsSearchable()

Commercetools\Api\Models\ProductType\AttributeDefinition::getIsSearchable

(

)

If true, the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets. However, if an Attribute's level is set as Product, then Product Projection Search does not support the Attribute.

The exact features that are available with this flag depend on the specific AttributeType. The maximum size of a searchable field is restricted by the Field content size limit. This constraint is enforced at both Product creation and Product update. If the length of the input exceeds the maximum size, an InvalidField error is returned.

Returns

null|bool

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getLabel()

Commercetools\Api\Models\ProductType\AttributeDefinition::getLabel

(

)

Human-readable label for the Attribute.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getLevel()

Commercetools\Api\Models\ProductType\AttributeDefinition::getLevel

(

)

Specifies whether the Attribute is defined at the Product or Variant level.

Returns

null|string

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getName()

Commercetools\Api\Models\ProductType\AttributeDefinition::getName

(

)

User-defined name of the Attribute that is unique within the Project.

Returns

null|string

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

getType()

Commercetools\Api\Models\ProductType\AttributeDefinition::getType

(

)

Describes the Type of the Attribute.

Returns

null|AttributeType

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setAttributeConstraint()

Commercetools\Api\Models\ProductType\AttributeDefinition::setAttributeConstraint

(

?string

$attributeConstraint

)

Parameters

?string

$attributeConstraint

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setInputHint()

Commercetools\Api\Models\ProductType\AttributeDefinition::setInputHint

(

?string

$inputHint

)

Parameters

?string

$inputHint

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setInputTip()

Commercetools\Api\Models\ProductType\AttributeDefinition::setInputTip

(

?LocalizedString

$inputTip

)

Parameters

?LocalizedString

$inputTip

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setIsRequired()

Commercetools\Api\Models\ProductType\AttributeDefinition::setIsRequired

(

?bool

$isRequired

)

Parameters

?bool

$isRequired

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setIsSearchable()

Commercetools\Api\Models\ProductType\AttributeDefinition::setIsSearchable

(

?bool

$isSearchable

)

Parameters

?bool

$isSearchable

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setLabel()

Commercetools\Api\Models\ProductType\AttributeDefinition::setLabel

(

?LocalizedString

$label

)

Parameters

?LocalizedString

$label

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setLevel()

Commercetools\Api\Models\ProductType\AttributeDefinition::setLevel

(

?string

$level

)

Parameters

?string

$level

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setName()

Commercetools\Api\Models\ProductType\AttributeDefinition::setName

(

?string

$name

)

Parameters

?string

$name

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

setType()

Commercetools\Api\Models\ProductType\AttributeDefinition::setType

(

?AttributeType

$type

)

Parameters

?AttributeType

$type

Implemented in Commercetools\Api\Models\ProductType\AttributeDefinitionModel.

Member Data Documentation

FIELD_ATTRIBUTE_CONSTRAINT

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_ATTRIBUTE_CONSTRAINT = 'attributeConstraint'

Definition at line 22 of file AttributeDefinition.php.

FIELD_INPUT_HINT

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_INPUT_HINT = 'inputHint'

Definition at line 24 of file AttributeDefinition.php.

FIELD_INPUT_TIP

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_INPUT_TIP = 'inputTip'

Definition at line 23 of file AttributeDefinition.php.

FIELD_IS_REQUIRED

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_IS_REQUIRED = 'isRequired'

Definition at line 20 of file AttributeDefinition.php.

FIELD_IS_SEARCHABLE

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_IS_SEARCHABLE = 'isSearchable'

Definition at line 25 of file AttributeDefinition.php.

FIELD_LABEL

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_LABEL = 'label'

Definition at line 19 of file AttributeDefinition.php.

FIELD_LEVEL

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_LEVEL = 'level'

Definition at line 21 of file AttributeDefinition.php.

FIELD_NAME

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_NAME = 'name'

Definition at line 18 of file AttributeDefinition.php.

FIELD_TYPE

const Commercetools\Api\Models\ProductType\AttributeDefinition::FIELD_TYPE = 'type'

Definition at line 17 of file AttributeDefinition.php.

---

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

• lib/commercetools-api/src/Models/ProductType/AttributeDefinition.php