Inherits Commercetools\Base\JsonObjectModel, and Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Public Member Functions
	__construct (?array $expand=null, ?bool $staged=null, ?string $priceCurrency=null, ?string $priceCountry=null, ?string $priceCustomerGroup=null, ?array $priceCustomerGroupAssignments=null, ?string $priceChannel=null, ?array $localeProjection=null, ?string $storeProjection=null)

	getExpand ()

	getStaged ()

	getPriceCurrency ()

	getPriceCountry ()

	getPriceCustomerGroup ()

	getPriceCustomerGroupAssignments ()

	getPriceChannel ()

	getLocaleProjection ()

	getStoreProjection ()

	setExpand (?array $expand)

	setStaged (?bool $staged)

	setPriceCurrency (?string $priceCurrency)

	setPriceCountry (?string $priceCountry)

	setPriceCustomerGroup (?string $priceCustomerGroup)

	setPriceCustomerGroupAssignments (?array $priceCustomerGroupAssignments)

	setPriceChannel (?string $priceChannel)

	setLocaleProjection (?array $localeProjection)

	setStoreProjection (?string $storeProjection)

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
	$expand

	$staged

	$priceCurrency

	$priceCountry

	$priceCustomerGroup

	$priceCustomerGroupAssignments

	$priceChannel

	$localeProjection

	$storeProjection

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\ProductSearch\ProductSearchProjectionParams
const	FIELD_EXPAND = 'expand'

const	FIELD_STAGED = 'staged'

const	FIELD_PRICE_CURRENCY = 'priceCurrency'

const	FIELD_PRICE_COUNTRY = 'priceCountry'

const	FIELD_PRICE_CUSTOMER_GROUP = 'priceCustomerGroup'

const	FIELD_PRICE_CUSTOMER_GROUP_ASSIGNMENTS = 'priceCustomerGroupAssignments'

const	FIELD_PRICE_CHANNEL = 'priceChannel'

const	FIELD_LOCALE_PROJECTION = 'localeProjection'

const	FIELD_STORE_PROJECTION = 'storeProjection'

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 ProductSearchProjectionParamsModel.php.

Constructor & Destructor Documentation

◆ __construct()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::__construct	(	?array	$expand = `null`,
		?bool	$staged = `null`,
		?string	$priceCurrency = `null`,
		?string	$priceCountry = `null`,
		?string	$priceCustomerGroup = `null`,
		?array	$priceCustomerGroupAssignments = `null`,
		?string	$priceChannel = `null`,
		?array	$localeProjection = `null`,
		?string	$storeProjection = `null`
	)

@psalm-suppress MissingParamType

Definition at line 80 of file ProductSearchProjectionParamsModel.php.

Member Function Documentation

◆ getExpand()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getExpand ( )

Expands a value of type Reference in a ProductProjection. In case the referenced object does not exist, the API returns the non-expanded reference.

Returns: null|array

@psalm-var ?list<mixed> $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 109 of file ProductSearchProjectionParamsModel.php.

◆ getLocaleProjection()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getLocaleProjection ( )

Used for locale-based projection.

Returns: null|array

@psalm-var ?list<mixed> $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 249 of file ProductSearchProjectionParamsModel.php.

◆ getPriceChannel()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getPriceChannel ( )

id of an existing Channel used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 229 of file ProductSearchProjectionParamsModel.php.

◆ getPriceCountry()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getPriceCountry ( )

The country used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 169 of file ProductSearchProjectionParamsModel.php.

◆ getPriceCurrency()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getPriceCurrency ( )

The currency used for Product price selection.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 149 of file ProductSearchProjectionParamsModel.php.

◆ getPriceCustomerGroup()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getPriceCustomerGroup ( )

id of an existing CustomerGroup used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 189 of file ProductSearchProjectionParamsModel.php.

◆ getPriceCustomerGroupAssignments()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getPriceCustomerGroupAssignments ( )

IDs of existing CustomerGroups used for Product price selection, when using multiple Customer Groups. It can be used only in conjunction with the priceCurrency parameter.

Returns: null|array

@psalm-var ?list<mixed> $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 209 of file ProductSearchProjectionParamsModel.php.

◆ getStaged()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getStaged ( )

Set to true to retrieve the staged Product Projection

Returns: null|bool

@psalm-var ?bool $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 129 of file ProductSearchProjectionParamsModel.php.

◆ getStoreProjection()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::getStoreProjection ( )

key of an existing Store. If the Store has defined languages, countries, distributionChannels, or supplyChannels, they are used for projections based on locale, price, and inventory.

For Projects with active Product Selections, the API does not take the availability of the Product in the specified Store into account.

Product Tailoring modifies the product information returned in API responses. However, you can only specify query expressions for the original Product data, not for tailored data.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 274 of file ProductSearchProjectionParamsModel.php.

◆ setExpand()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setExpand ( ?array $expand )

Parameters

?array $expand

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 292 of file ProductSearchProjectionParamsModel.php.

◆ setLocaleProjection()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setLocaleProjection ( ?array $localeProjection )

Parameters

?array $localeProjection

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 348 of file ProductSearchProjectionParamsModel.php.

◆ setPriceChannel()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setPriceChannel ( ?string $priceChannel )

Parameters

?string $priceChannel

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 340 of file ProductSearchProjectionParamsModel.php.

◆ setPriceCountry()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setPriceCountry ( ?string $priceCountry )

Parameters

?string $priceCountry

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 316 of file ProductSearchProjectionParamsModel.php.

◆ setPriceCurrency()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setPriceCurrency ( ?string $priceCurrency )

Parameters

?string $priceCurrency

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 308 of file ProductSearchProjectionParamsModel.php.

◆ setPriceCustomerGroup()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setPriceCustomerGroup ( ?string $priceCustomerGroup )

Parameters

?string $priceCustomerGroup

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 324 of file ProductSearchProjectionParamsModel.php.

◆ setPriceCustomerGroupAssignments()

Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParamsModel::setPriceCustomerGroupAssignments ( ?array $priceCustomerGroupAssignments )

Parameters

?array $priceCustomerGroupAssignments

Implements Commercetools\Api\Models\ProductSearch\ProductSearchProjectionParams.

Definition at line 332 of file ProductSearchProjectionParamsModel.php.