Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet Class Reference

Inheritance diagram for Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet:

Public Member Functions
	__construct (string $projectKey, $body=null, array $headers=[], ClientInterface $client=null)
	mapFromResponse (?ResponseInterface $response, string $resultType=null)
	execute (array $options=[], string $resultType=null)
	executeAsync (array $options=[], string $resultType=null)
	withStaged ($staged)
	withPriceCurrency ($priceCurrency)
	withPriceCountry ($priceCountry)
	withPriceCustomerGroup ($priceCustomerGroup)
	withPriceChannel ($priceChannel)
	withLocaleProjection ($localeProjection)
	withStoreProjection ($storeProjection)
	withExpand ($expand)
	withSort ($sort)
	withLimit ($limit)
	withOffset ($offset)
	withWithTotal ($withTotal)
	withWhere ($where)
	withPredicateVar (string $varName, $predicateVar)
Public Member Functions inherited from Commercetools\Client\ApiRequest
	__construct (?ClientInterface $client, string $method, string $uri, array $headers=[], $body=null, string $version='1.1')
	withQueryParam (string $parameterName, $value)
	send (array $options=[])
	sendAsync (array $options=[])
	getClient ()
Public Member Functions inherited from Commercetools\Api\Client\Resource\ProjectionSelecting
	withStaged (bool $staged)
Public Member Functions inherited from Commercetools\Api\Client\Resource\PriceSelecting
	withPriceCurrency (string $priceCurrency)
	withPriceCountry (string $priceCountry)
	withPriceCustomerGroup (string $priceCustomerGroup)
	withPriceChannel (string $priceChannel)
	withLocaleProjection (string $localeProjection)
Public Member Functions inherited from Commercetools\Api\Client\Resource\LocaleProjecting
	withLocaleProjection (string $localeProjection)
Public Member Functions inherited from Commercetools\Api\Client\Resource\StoreProjecting
	withStoreProjection (string $storeProjection)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Expandable
	withExpand (string $expand)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Sortable
	withSort (string $sort)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Paging
	withLimit (int $limit)
	withOffset (int $offset)
	withWithTotal (bool $withTotal)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Query
	withWhere (string $where)

Additional Inherited Members
Protected Member Functions inherited from Commercetools\Client\ApiRequest
	ensureHeader (array $headers, string $header, $defaultValue)
	responseData (ResponseInterface $response)

Detailed Description

@psalm-suppress PropertyNotSetInConstructor @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsGet> @template-implements PriceSelecting<ByProjectKeyProductProjectionsGet> @template-implements LocaleProjecting<ByProjectKeyProductProjectionsGet> @template-implements StoreProjecting<ByProjectKeyProductProjectionsGet> @template-implements Expandable<ByProjectKeyProductProjectionsGet> @template-implements Sortable<ByProjectKeyProductProjectionsGet> @template-implements Paging<ByProjectKeyProductProjectionsGet> @template-implements Query<ByProjectKeyProductProjectionsGet> @template-implements Errorable<ByProjectKeyProductProjectionsGet> @template-implements Deprecatable200<ByProjectKeyProductProjectionsGet>

Definition at line 44 of file ByProjectKeyProductProjectionsGet.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::__construct	(	string	$projectKey,
			$body = null,
		array	$headers = [],
		ClientInterface	$client = null
	)

Parameters

?object|array|string

$body @psalm-param array<string, scalar|scalar[]> $headers

Definition at line 50 of file ByProjectKeyProductProjectionsGet.php.

Member Function Documentation

execute()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::execute	(	array	$options = [],
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

null|T|ErrorResponse|JsonObject|ProductProjectionPagedQueryResponse

Definition at line 112 of file ByProjectKeyProductProjectionsGet.php.

executeAsync()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::executeAsync	(	array	$options = [],
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

PromiseInterface

Definition at line 135 of file ByProjectKeyProductProjectionsGet.php.

mapFromResponse()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::mapFromResponse	(	?ResponseInterface	$response,
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

ErrorResponse|JsonObject|ProductProjectionPagedQueryResponse|T|null

Definition at line 61 of file ByProjectKeyProductProjectionsGet.php.

withExpand()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withExpand

(

$expand

)

@psalm-param scalar|scalar[] $expand

Definition at line 221 of file ByProjectKeyProductProjectionsGet.php.

withLimit()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withLimit

(

$limit

)

@psalm-param scalar|scalar[] $limit

Definition at line 239 of file ByProjectKeyProductProjectionsGet.php.

withLocaleProjection()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withLocaleProjection

(

$localeProjection

)

@psalm-param scalar|scalar[] $localeProjection

Definition at line 203 of file ByProjectKeyProductProjectionsGet.php.

withOffset()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withOffset

(

$offset

)

@psalm-param scalar|scalar[] $offset

Definition at line 248 of file ByProjectKeyProductProjectionsGet.php.

withPredicateVar()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withPredicateVar	(	string	$varName,
			$predicateVar
	)

@psalm-param string $varName @psalm-param scalar|scalar[] $predicateVar

Definition at line 275 of file ByProjectKeyProductProjectionsGet.php.

withPriceChannel()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withPriceChannel

(

$priceChannel

)

@psalm-param scalar|scalar[] $priceChannel

Definition at line 194 of file ByProjectKeyProductProjectionsGet.php.

withPriceCountry()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withPriceCountry

(

$priceCountry

)

@psalm-param scalar|scalar[] $priceCountry

Definition at line 176 of file ByProjectKeyProductProjectionsGet.php.

withPriceCurrency()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withPriceCurrency

(

$priceCurrency

)

@psalm-param scalar|scalar[] $priceCurrency

Definition at line 167 of file ByProjectKeyProductProjectionsGet.php.

withPriceCustomerGroup()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withPriceCustomerGroup

(

$priceCustomerGroup

)

@psalm-param scalar|scalar[] $priceCustomerGroup

Definition at line 185 of file ByProjectKeyProductProjectionsGet.php.

withSort()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withSort

(

$sort

)

@psalm-param scalar|scalar[] $sort

Definition at line 230 of file ByProjectKeyProductProjectionsGet.php.

withStaged()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withStaged

(

$staged

)

@psalm-param scalar|scalar[] $staged

Definition at line 158 of file ByProjectKeyProductProjectionsGet.php.

withStoreProjection()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withStoreProjection

(

$storeProjection

)

@psalm-param scalar|scalar[] $storeProjection

Definition at line 212 of file ByProjectKeyProductProjectionsGet.php.

withWhere()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withWhere

(

$where

)

@psalm-param scalar|scalar[] $where

Definition at line 266 of file ByProjectKeyProductProjectionsGet.php.

withWithTotal()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsGet::withWithTotal

(

$withTotal

)

@psalm-param scalar|scalar[] $withTotal

Definition at line 257 of file ByProjectKeyProductProjectionsGet.php.

---

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

• lib/commercetools-api/src/Client/Resource/ByProjectKeyProductProjectionsGet.php