Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel Class Reference

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

Public Member Functions
	__construct (?int $variantId=null, ?string $sku=null, ?string $imageUrl=null, ?int $position=null, ?bool $staged=null, ?string $action=null)
	getAction ()
	getVariantId ()
	getSku ()
	getImageUrl ()
	getPosition ()
	getStaged ()
	setVariantId (?int $variantId)
	setSku (?string $sku)
	setImageUrl (?string $imageUrl)
	setPosition (?int $position)
	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 = 'moveImageToPosition'
Public Attributes inherited from Commercetools\Api\Models\Product\ProductMoveImageToPositionAction
const	FIELD_VARIANT_ID = 'variantId'
const	FIELD_SKU = 'sku'
const	FIELD_IMAGE_URL = 'imageUrl'
const	FIELD_POSITION = 'position'
const	FIELD_STAGED = 'staged'
Public Attributes inherited from Commercetools\Api\Models\Product\ProductUpdateAction
const	DISCRIMINATOR_FIELD = 'action'
const	FIELD_ACTION = 'action'

Protected Attributes
	$action
	$variantId
	$sku
	$imageUrl
	$position
	$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 20 of file ProductMoveImageToPositionActionModel.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::__construct	(	?int	$variantId = null,
		?string	$sku = null,
		?string	$imageUrl = null,
		?int	$position = null,
		?bool	$staged = null,
		?string	$action = null
	)

@psalm-suppress MissingParamType

Definition at line 63 of file ProductMoveImageToPositionActionModel.php.

Member Function Documentation

getAction()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::getAction

(

)

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Product\ProductUpdateAction.

Definition at line 83 of file ProductMoveImageToPositionActionModel.php.

getImageUrl()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::getImageUrl

(

)

The URL of the image to update.

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 143 of file ProductMoveImageToPositionActionModel.php.

getPosition()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::getPosition

(

)

Position in images where the image should be moved. Must be between 0 and the total number of images minus 1.

Returns

null|int

@psalm-var ?int $data

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 163 of file ProductMoveImageToPositionActionModel.php.

getSku()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::getSku

(

)

The sku of the ProductVariant to update.

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 123 of file ProductMoveImageToPositionActionModel.php.

getStaged()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::getStaged

(

)

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

Returns

null|bool

@psalm-var ?bool $data

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 183 of file ProductMoveImageToPositionActionModel.php.

getVariantId()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::getVariantId

(

)

The id of the ProductVariant to update.

Returns

null|int

@psalm-var ?int $data

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 103 of file ProductMoveImageToPositionActionModel.php.

setImageUrl()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::setImageUrl

(

?string

$imageUrl

)

Parameters

?string

$imageUrl

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 217 of file ProductMoveImageToPositionActionModel.php.

setPosition()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::setPosition

(

?int

$position

)

Parameters

?int

$position

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 225 of file ProductMoveImageToPositionActionModel.php.

setSku()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::setSku

(

?string

$sku

)

Parameters

?string

$sku

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 209 of file ProductMoveImageToPositionActionModel.php.

setStaged()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::setStaged

(

?bool

$staged

)

Parameters

?bool

$staged

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 233 of file ProductMoveImageToPositionActionModel.php.

setVariantId()

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::setVariantId

(

?int

$variantId

)

Parameters

?int	$variantId

Implements Commercetools\Api\Models\Product\ProductMoveImageToPositionAction.

Definition at line 201 of file ProductMoveImageToPositionActionModel.php.

Member Data Documentation

$action

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

protected

Definition at line 27 of file ProductMoveImageToPositionActionModel.php.

$imageUrl

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::$imageUrl

protected

Definition at line 45 of file ProductMoveImageToPositionActionModel.php.

$position

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::$position

protected

Definition at line 51 of file ProductMoveImageToPositionActionModel.php.

$sku

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::$sku

protected

Definition at line 39 of file ProductMoveImageToPositionActionModel.php.

$staged

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

protected

Definition at line 57 of file ProductMoveImageToPositionActionModel.php.

$variantId

Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::$variantId

protected

Definition at line 33 of file ProductMoveImageToPositionActionModel.php.

DISCRIMINATOR_VALUE

const Commercetools\Api\Models\Product\ProductMoveImageToPositionActionModel::DISCRIMINATOR_VALUE = 'moveImageToPosition'

Definition at line 22 of file ProductMoveImageToPositionActionModel.php.

---

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

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