Commercetools\Api\Models\Product\ProductChangeNameActionModel Class Reference

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

Public Member Functions
	__construct (?LocalizedString $name=null, ?bool $staged=null, ?string $action=null)
	getAction ()
	getName ()
	getStaged ()
	setName (?LocalizedString $name)
	setStaged (?bool $staged)
Public Member Functions inherited from Commercetools\Base\JsonObjectModel
	get (string $field)
	with (?callable $callable=null)
Public Member Functions inherited from Commercetools\Base\BaseJsonObject
	jsonSerialize ()

Public Attributes
const	DISCRIMINATOR_VALUE = 'changeName'
Public Attributes inherited from Commercetools\Api\Models\Product\ProductChangeNameAction
const	FIELD_NAME = 'name'
const	FIELD_STAGED = 'staged'
Public Attributes inherited from Commercetools\Api\Models\Product\ProductUpdateAction
const	DISCRIMINATOR_FIELD = 'action'
const	FIELD_ACTION = 'action'

Protected Attributes
	$action
	$name
	$staged

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=[])
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 22 of file ProductChangeNameActionModel.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Api\Models\Product\ProductChangeNameActionModel::__construct	(	?LocalizedString	$name = null,
		?bool	$staged = null,
		?string	$action = null
	)

@psalm-suppress MissingParamType

Definition at line 47 of file ProductChangeNameActionModel.php.

Member Function Documentation

getAction()

Commercetools\Api\Models\Product\ProductChangeNameActionModel::getAction

(

)

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Product\ProductUpdateAction.

Definition at line 61 of file ProductChangeNameActionModel.php.

getName()

Commercetools\Api\Models\Product\ProductChangeNameActionModel::getName

(

)

Value to set. Must not be empty.

Returns

null|LocalizedString

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

Implements Commercetools\Api\Models\Product\ProductChangeNameAction.

Definition at line 81 of file ProductChangeNameActionModel.php.

getStaged()

Commercetools\Api\Models\Product\ProductChangeNameActionModel::getStaged

(

)

If true, only the staged name is updated. If false, both the current and staged name are updated.

Returns

null|bool

@psalm-var ?bool $data

Implements Commercetools\Api\Models\Product\ProductChangeNameAction.

Definition at line 102 of file ProductChangeNameActionModel.php.

setName()

Commercetools\Api\Models\Product\ProductChangeNameActionModel::setName

(

?LocalizedString

$name

)

Parameters

?LocalizedString

$name

Implements Commercetools\Api\Models\Product\ProductChangeNameAction.

Definition at line 120 of file ProductChangeNameActionModel.php.

setStaged()

Commercetools\Api\Models\Product\ProductChangeNameActionModel::setStaged

(

?bool

$staged

)

Parameters

?bool

$staged

Implements Commercetools\Api\Models\Product\ProductChangeNameAction.

Definition at line 128 of file ProductChangeNameActionModel.php.

Member Data Documentation

$action

Commercetools\Api\Models\Product\ProductChangeNameActionModel::$action

protected

Definition at line 29 of file ProductChangeNameActionModel.php.

$name

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

protected

Definition at line 35 of file ProductChangeNameActionModel.php.

$staged

Commercetools\Api\Models\Product\ProductChangeNameActionModel::$staged

protected

Definition at line 41 of file ProductChangeNameActionModel.php.

DISCRIMINATOR_VALUE

const Commercetools\Api\Models\Product\ProductChangeNameActionModel::DISCRIMINATOR_VALUE = 'changeName'

Definition at line 24 of file ProductChangeNameActionModel.php.

---

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

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