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\ByProjectKeyGet Class Reference
Inheritance diagram for Commercetools\Api\Client\Resource\ByProjectKeyGet:
Commercetools\Client\ApiRequest Commercetools\Api\Client\Resource\Errorable Commercetools\Api\Client\Resource\Deprecatable200 Commercetools\Client\ApiRequestInterface Commercetools\Client\ApiRequestInterface Commercetools\Client\ApiRequestInterface

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)
 
- 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 ()
 

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 Errorable<ByProjectKeyGet> @template-implements Deprecatable200<ByProjectKeyGet>

Definition at line 36 of file ByProjectKeyGet.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ execute()

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

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

Returns
null|T|ErrorResponse|JsonObject|Project

Definition at line 104 of file ByProjectKeyGet.php.

◆ executeAsync()

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

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

Returns
PromiseInterface

Definition at line 127 of file ByProjectKeyGet.php.

◆ mapFromResponse()

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

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

Returns
ErrorResponse|JsonObject|Project|T|null

Definition at line 53 of file ByProjectKeyGet.php.


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