commercetools-sdk-php-v2  master
The platform, import-api and ml-api PHP sdks generated from our api reference.
Public Member Functions | List of all members
Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet Class Reference
Inheritance diagram for Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet:
Commercetools\Api\Client\Resource\Deprecatable200 Commercetools\Api\Client\Resource\Errorable Commercetools\Api\Client\Resource\Expandable Commercetools\Api\Client\Resource\StoreProjecting Commercetools\Api\Client\Resource\LocaleProjecting Commercetools\Api\Client\Resource\PriceSelecting Commercetools\Api\Client\Resource\ProjectionSelecting Commercetools\Api\Client\Resource\Paging Commercetools\Api\Client\Resource\Sortable Commercetools\Client\ApiRequest

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)
 
 withFuzzy ($fuzzy)
 
 withFuzzyLevel ($fuzzyLevel)
 
 withMarkMatchingVariants ($markMatchingVariants)
 
 withFilter ($filter)
 
 withFilterFacets ($filterFacets)
 
 withFilterQuery ($filterQuery)
 
 withFacet ($facet)
 
 withText (string $locale, $text)
 
 withSort ($sort)
 
 withLimit ($limit)
 
 withOffset ($offset)
 
 withWithTotal ($withTotal)
 
 withStaged ($staged)
 
 withPriceCurrency ($priceCurrency)
 
 withPriceCountry ($priceCountry)
 
 withPriceCustomerGroup ($priceCustomerGroup)
 
 withPriceChannel ($priceChannel)
 
 withLocaleProjection ($localeProjection)
 
 withStoreProjection ($storeProjection)
 
 withExpand ($expand)
 
- 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\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\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)
 

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 Sortable<ByProjectKeyProductProjectionsSearchGet> @template-implements Paging<ByProjectKeyProductProjectionsSearchGet> @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsSearchGet> @template-implements PriceSelecting<ByProjectKeyProductProjectionsSearchGet> @template-implements LocaleProjecting<ByProjectKeyProductProjectionsSearchGet> @template-implements StoreProjecting<ByProjectKeyProductProjectionsSearchGet> @template-implements Expandable<ByProjectKeyProductProjectionsSearchGet> @template-implements Errorable<ByProjectKeyProductProjectionsSearchGet> @template-implements Deprecatable200<ByProjectKeyProductProjectionsSearchGet>

Definition at line 43 of file ByProjectKeyProductProjectionsSearchGet.php.

Constructor & Destructor Documentation

◆ __construct()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::__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 49 of file ByProjectKeyProductProjectionsSearchGet.php.

Member Function Documentation

◆ execute()

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

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

Returns
null|T|ErrorResponse|JsonObject|ProductProjectionPagedSearchResponse

Definition at line 111 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ executeAsync()

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

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

Returns
PromiseInterface

Definition at line 134 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ mapFromResponse()

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

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

Returns
ErrorResponse|JsonObject|ProductProjectionPagedSearchResponse|T|null

Definition at line 60 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withExpand()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withExpand (   $expand)

@psalm-param scalar|scalar[] $expand

Definition at line 328 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withFacet()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withFacet (   $facet)

@psalm-param scalar|scalar[] $facet

Definition at line 211 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withFilter()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withFilter (   $filter)

@psalm-param scalar|scalar[] $filter

Definition at line 184 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withFilterFacets()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withFilterFacets (   $filterFacets)

@psalm-param scalar|scalar[] $filterFacets

Definition at line 193 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withFilterQuery()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withFilterQuery (   $filterQuery)

@psalm-param scalar|scalar[] $filterQuery

Definition at line 202 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withFuzzy()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withFuzzy (   $fuzzy)

@psalm-param scalar|scalar[] $fuzzy

Definition at line 157 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withFuzzyLevel()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withFuzzyLevel (   $fuzzyLevel)

@psalm-param scalar|scalar[] $fuzzyLevel

Definition at line 166 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withLimit()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withLimit (   $limit)

@psalm-param scalar|scalar[] $limit

Definition at line 238 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withLocaleProjection()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withLocaleProjection (   $localeProjection)

@psalm-param scalar|scalar[] $localeProjection

Definition at line 310 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withMarkMatchingVariants()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withMarkMatchingVariants (   $markMatchingVariants)

@psalm-param scalar|scalar[] $markMatchingVariants

Definition at line 175 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withOffset()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withOffset (   $offset)

@psalm-param scalar|scalar[] $offset

Definition at line 247 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withPriceChannel()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withPriceChannel (   $priceChannel)

@psalm-param scalar|scalar[] $priceChannel

Definition at line 301 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withPriceCountry()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withPriceCountry (   $priceCountry)

@psalm-param scalar|scalar[] $priceCountry

Definition at line 283 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withPriceCurrency()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withPriceCurrency (   $priceCurrency)

@psalm-param scalar|scalar[] $priceCurrency

Definition at line 274 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withPriceCustomerGroup()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withPriceCustomerGroup (   $priceCustomerGroup)

@psalm-param scalar|scalar[] $priceCustomerGroup

Definition at line 292 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withSort()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withSort (   $sort)

@psalm-param scalar|scalar[] $sort

Definition at line 229 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withStaged()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withStaged (   $staged)

@psalm-param scalar|scalar[] $staged

Definition at line 265 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withStoreProjection()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withStoreProjection (   $storeProjection)

@psalm-param scalar|scalar[] $storeProjection

Definition at line 319 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withText()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withText ( string  $locale,
  $text 
)

@psalm-param string $locale @psalm-param scalar|scalar[] $text

Definition at line 220 of file ByProjectKeyProductProjectionsSearchGet.php.

◆ withWithTotal()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSearchGet::withWithTotal (   $withTotal)

@psalm-param scalar|scalar[] $withTotal

Definition at line 256 of file ByProjectKeyProductProjectionsSearchGet.php.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1