Inherits Commercetools\Base\JsonObjectModel, and Commercetools\Api\Models\Product\ProductData.

Public Member Functions
	__construct (?LocalizedString $name=null, ?CategoryReferenceCollection $categories=null, ?CategoryOrderHints $categoryOrderHints=null, ?LocalizedString $description=null, ?LocalizedString $slug=null, ?LocalizedString $metaTitle=null, ?LocalizedString $metaDescription=null, ?LocalizedString $metaKeywords=null, ?ProductVariant $masterVariant=null, ?ProductVariantCollection $variants=null, ?SearchKeywords $searchKeywords=null, ?AttributeCollection $attributes=null)

	getName ()

	getCategories ()

	getCategoryOrderHints ()

	getDescription ()

	getSlug ()

	getMetaTitle ()

	getMetaDescription ()

	getMetaKeywords ()

	getMasterVariant ()

	getVariants ()

	getSearchKeywords ()

	getAttributes ()

	setName (?LocalizedString $name)

	setCategories (?CategoryReferenceCollection $categories)

	setCategoryOrderHints (?CategoryOrderHints $categoryOrderHints)

	setDescription (?LocalizedString $description)

	setSlug (?LocalizedString $slug)

	setMetaTitle (?LocalizedString $metaTitle)

	setMetaDescription (?LocalizedString $metaDescription)

	setMetaKeywords (?LocalizedString $metaKeywords)

	setMasterVariant (?ProductVariant $masterVariant)

	setVariants (?ProductVariantCollection $variants)

	setSearchKeywords (?SearchKeywords $searchKeywords)

	setAttributes (?AttributeCollection $attributes)

Public Member Functions inherited from Commercetools\Base\JsonObjectModel
	get (string $field)

	with (?callable $callable=null)

Public Member Functions inherited from Commercetools\Base\BaseJsonObject
	jsonSerialize ()

Protected Attributes
	$name

	$categories

	$categoryOrderHints

	$description

	$slug

	$metaTitle

	$metaDescription

	$metaKeywords

	$masterVariant

	$variants

	$searchKeywords

	$attributes

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\BaseJsonObject
static	of ($data=null)

static	fromStdClass (?stdClass $data=null)

static	fromArray (array $data=[])

Public Attributes inherited from Commercetools\Api\Models\Product\ProductData
const	FIELD_NAME = 'name'

const	FIELD_CATEGORIES = 'categories'

const	FIELD_CATEGORY_ORDER_HINTS = 'categoryOrderHints'

const	FIELD_DESCRIPTION = 'description'

const	FIELD_SLUG = 'slug'

const	FIELD_META_TITLE = 'metaTitle'

const	FIELD_META_DESCRIPTION = 'metaDescription'

const	FIELD_META_KEYWORDS = 'metaKeywords'

const	FIELD_MASTER_VARIANT = 'masterVariant'

const	FIELD_VARIANTS = 'variants'

const	FIELD_SEARCH_KEYWORDS = 'searchKeywords'

const	FIELD_ATTRIBUTES = 'attributes'

Protected Member Functions inherited from Commercetools\Base\JsonObjectModel
	toArray ()

Protected Member Functions inherited from Commercetools\Base\BaseJsonObject
	raw (string $field)

	getRawDataArray ()

Detailed Description

Definition at line 23 of file ProductDataModel.php.

Constructor & Destructor Documentation

◆ __construct()

Commercetools\Api\Models\Product\ProductDataModel::__construct	(	?LocalizedString	$name = `null`,
		?CategoryReferenceCollection	$categories = `null`,
		?CategoryOrderHints	$categoryOrderHints = `null`,
		?LocalizedString	$description = `null`,
		?LocalizedString	$slug = `null`,
		?LocalizedString	$metaTitle = `null`,
		?LocalizedString	$metaDescription = `null`,
		?LocalizedString	$metaKeywords = `null`,
		?ProductVariant	$masterVariant = `null`,
		?ProductVariantCollection	$variants = `null`,
		?SearchKeywords	$searchKeywords = `null`,
		?AttributeCollection	$attributes = `null`
	)

@psalm-suppress MissingParamType

Definition at line 101 of file ProductDataModel.php.

Member Function Documentation

◆ getAttributes()

Commercetools\Api\Models\Product\ProductDataModel::getAttributes ( )

Product Attributes according to the respective AttributeDefinition. Not supported by Product Projection Search.

Returns: null|AttributeCollection

@psalm-var ?list<stdClass> $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 367 of file ProductDataModel.php.

◆ getCategories()

Commercetools\Api\Models\Product\ProductDataModel::getCategories ( )

Categories assigned to the Product.

Returns: null|CategoryReferenceCollection

@psalm-var ?list<stdClass> $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 156 of file ProductDataModel.php.

◆ getCategoryOrderHints()

Commercetools\Api\Models\Product\ProductDataModel::getCategoryOrderHints ( )

Numerical values to allow ordering of Products within a specified Category.

Returns: null|CategoryOrderHints

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 176 of file ProductDataModel.php.

◆ getDescription()

Commercetools\Api\Models\Product\ProductDataModel::getDescription ( )

Description of the Product.

Returns: null|LocalizedString

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 197 of file ProductDataModel.php.

◆ getMasterVariant()

Commercetools\Api\Models\Product\ProductDataModel::getMasterVariant ( )

The Master Variant of the Product.

Returns: null|ProductVariant

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 304 of file ProductDataModel.php.

◆ getMetaDescription()

Commercetools\Api\Models\Product\ProductDataModel::getMetaDescription ( )

Description of the Product as used by search engines.

Returns: null|LocalizedString

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 262 of file ProductDataModel.php.

◆ getMetaKeywords()

Commercetools\Api\Models\Product\ProductDataModel::getMetaKeywords ( )

Keywords that give additional information about the Product to search engines.

Returns: null|LocalizedString

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 283 of file ProductDataModel.php.

◆ getMetaTitle()

Commercetools\Api\Models\Product\ProductDataModel::getMetaTitle ( )

Title of the Product as used by search engines.

Returns: null|LocalizedString

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 241 of file ProductDataModel.php.

◆ getName()

Commercetools\Api\Models\Product\ProductDataModel::getName ( )

Name of the Product.

Returns: null|LocalizedString

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 135 of file ProductDataModel.php.

◆ getSearchKeywords()

Commercetools\Api\Models\Product\ProductDataModel::getSearchKeywords ( )

Used by Search Term Suggestions, but is also considered for a full text search in the Product Projection Search API.

Returns: null|SearchKeywords

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 345 of file ProductDataModel.php.

◆ getSlug()

Commercetools\Api\Models\Product\ProductDataModel::getSlug ( )

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_-]{2,256}.

Returns: null|LocalizedString

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 220 of file ProductDataModel.php.

◆ getVariants()

Commercetools\Api\Models\Product\ProductDataModel::getVariants ( )

Additional Product Variants.

Returns: null|ProductVariantCollection

@psalm-var ?list<stdClass> $data

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 325 of file ProductDataModel.php.

◆ setAttributes()

Commercetools\Api\Models\Product\ProductDataModel::setAttributes ( ?AttributeCollection $attributes )

Parameters

?AttributeCollection $attributes

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 473 of file ProductDataModel.php.

◆ setCategories()

Commercetools\Api\Models\Product\ProductDataModel::setCategories ( ?CategoryReferenceCollection $categories )

Parameters

?CategoryReferenceCollection $categories

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 393 of file ProductDataModel.php.

◆ setCategoryOrderHints()

Commercetools\Api\Models\Product\ProductDataModel::setCategoryOrderHints ( ?CategoryOrderHints $categoryOrderHints )

Parameters

?CategoryOrderHints $categoryOrderHints

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 401 of file ProductDataModel.php.

◆ setDescription()

Commercetools\Api\Models\Product\ProductDataModel::setDescription ( ?LocalizedString $description )

Parameters

?LocalizedString $description

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 409 of file ProductDataModel.php.

◆ setMasterVariant()

Commercetools\Api\Models\Product\ProductDataModel::setMasterVariant ( ?ProductVariant $masterVariant )

Parameters

?ProductVariant $masterVariant

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 449 of file ProductDataModel.php.

◆ setMetaDescription()

Commercetools\Api\Models\Product\ProductDataModel::setMetaDescription ( ?LocalizedString $metaDescription )

Parameters

?LocalizedString $metaDescription

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 433 of file ProductDataModel.php.

◆ setMetaKeywords()

Commercetools\Api\Models\Product\ProductDataModel::setMetaKeywords ( ?LocalizedString $metaKeywords )

Parameters

?LocalizedString $metaKeywords

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 441 of file ProductDataModel.php.

◆ setMetaTitle()

Commercetools\Api\Models\Product\ProductDataModel::setMetaTitle ( ?LocalizedString $metaTitle )

Parameters

?LocalizedString $metaTitle

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 425 of file ProductDataModel.php.

◆ setName()

Commercetools\Api\Models\Product\ProductDataModel::setName ( ?LocalizedString $name )

Parameters

?LocalizedString $name

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 385 of file ProductDataModel.php.

◆ setSearchKeywords()

Commercetools\Api\Models\Product\ProductDataModel::setSearchKeywords ( ?SearchKeywords $searchKeywords )

Parameters

?SearchKeywords $searchKeywords

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 465 of file ProductDataModel.php.

◆ setSlug()

Commercetools\Api\Models\Product\ProductDataModel::setSlug ( ?LocalizedString $slug )

Parameters

?LocalizedString $slug

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 417 of file ProductDataModel.php.

◆ setVariants()

Commercetools\Api\Models\Product\ProductDataModel::setVariants ( ?ProductVariantCollection $variants )

Parameters

?ProductVariantCollection $variants

Implements Commercetools\Api\Models\Product\ProductData.

Definition at line 457 of file ProductDataModel.php.

Member Data Documentation

◆ $attributes

Commercetools\Api\Models\Product\ProductDataModel::$attributes

protected

Definition at line 95 of file ProductDataModel.php.

◆ $categories

Commercetools\Api\Models\Product\ProductDataModel::$categories

protected

Definition at line 35 of file ProductDataModel.php.

◆ $categoryOrderHints

Commercetools\Api\Models\Product\ProductDataModel::$categoryOrderHints

protected

Definition at line 41 of file ProductDataModel.php.

◆ $description

Commercetools\Api\Models\Product\ProductDataModel::$description

protected

Definition at line 47 of file ProductDataModel.php.

◆ $masterVariant

Commercetools\Api\Models\Product\ProductDataModel::$masterVariant

protected

Definition at line 77 of file ProductDataModel.php.

◆ $metaDescription

Commercetools\Api\Models\Product\ProductDataModel::$metaDescription

protected

Definition at line 65 of file ProductDataModel.php.

◆ $metaKeywords

Commercetools\Api\Models\Product\ProductDataModel::$metaKeywords

protected

Definition at line 71 of file ProductDataModel.php.

◆ $metaTitle

Commercetools\Api\Models\Product\ProductDataModel::$metaTitle

protected

Definition at line 59 of file ProductDataModel.php.

◆ $name

Commercetools\Api\Models\Product\ProductDataModel::$name

protected

Definition at line 29 of file ProductDataModel.php.

◆ $searchKeywords

Commercetools\Api\Models\Product\ProductDataModel::$searchKeywords

protected

Definition at line 89 of file ProductDataModel.php.

◆ $slug

Commercetools\Api\Models\Product\ProductDataModel::$slug

protected

Definition at line 53 of file ProductDataModel.php.

◆ $variants

Commercetools\Api\Models\Product\ProductDataModel::$variants

protected

Definition at line 83 of file ProductDataModel.php.

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

lib/commercetools-api/src/Models/Product/ProductDataModel.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAttributes()

◆ getCategories()

◆ getCategoryOrderHints()

◆ getDescription()

◆ getMasterVariant()

◆ getMetaDescription()

◆ getMetaKeywords()

◆ getMetaTitle()

◆ getName()

◆ getSearchKeywords()

◆ getSlug()

◆ getVariants()

◆ setAttributes()

◆ setCategories()

◆ setCategoryOrderHints()

◆ setDescription()

◆ setMasterVariant()

◆ setMetaDescription()

◆ setMetaKeywords()

◆ setMetaTitle()

◆ setName()

◆ setSearchKeywords()

◆ setSlug()

◆ setVariants()

Member Data Documentation

◆ $attributes

◆ $categories

◆ $categoryOrderHints

◆ $description

◆ $masterVariant

◆ $metaDescription

◆ $metaKeywords

◆ $metaTitle

◆ $name

◆ $searchKeywords

◆ $slug

◆ $variants