Inheritance diagram for Commercetools\Api\Models\Project\ProjectModel:

Public Member Functions
	__construct (?int $version=null, ?string $key=null, ?string $name=null, ?array $countries=null, ?array $currencies=null, ?array $languages=null, ?DateTimeImmutable $createdAt=null, ?string $trialUntil=null, ?MessagesConfiguration $messages=null, ?CartsConfiguration $carts=null, ?ShoppingListsConfiguration $shoppingLists=null, ?ShippingRateInputType $shippingRateInputType=null, ?ExternalOAuth $externalOAuth=null, ?SearchIndexingConfiguration $searchIndexing=null, ?BusinessUnitConfiguration $businessUnits=null)

	getVersion ()

	getKey ()

	getName ()

	getCountries ()

	getCurrencies ()

	getLanguages ()

	getCreatedAt ()

	getTrialUntil ()

	getMessages ()

	getCarts ()

	getShoppingLists ()

	getShippingRateInputType ()

	getExternalOAuth ()

	getSearchIndexing ()

	getBusinessUnits ()

	setVersion (?int $version)

	setKey (?string $key)

	setName (?string $name)

	setCountries (?array $countries)

	setCurrencies (?array $currencies)

	setLanguages (?array $languages)

	setCreatedAt (?DateTimeImmutable $createdAt)

	setTrialUntil (?string $trialUntil)

	setMessages (?MessagesConfiguration $messages)

	setCarts (?CartsConfiguration $carts)

	setShoppingLists (?ShoppingListsConfiguration $shoppingLists)

	setShippingRateInputType (?ShippingRateInputType $shippingRateInputType)

	setExternalOAuth (?ExternalOAuth $externalOAuth)

	setSearchIndexing (?SearchIndexingConfiguration $searchIndexing)

	setBusinessUnits (?BusinessUnitConfiguration $businessUnits)

	jsonSerialize ()

Public Member Functions inherited from Commercetools\Base\JsonObjectModel
	get (string $field)

	with (callable $callable=null)

Protected Attributes
	$version

	$key

	$name

	$countries

	$currencies

	$languages

	$createdAt

	$trialUntil

	$messages

	$carts

	$shoppingLists

	$shippingRateInputType

	$externalOAuth

	$searchIndexing

	$businessUnits

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\Project\Project
const	FIELD_VERSION = 'version'

const	FIELD_KEY = 'key'

const	FIELD_NAME = 'name'

const	FIELD_COUNTRIES = 'countries'

const	FIELD_CURRENCIES = 'currencies'

const	FIELD_LANGUAGES = 'languages'

const	FIELD_CREATED_AT = 'createdAt'

const	FIELD_TRIAL_UNTIL = 'trialUntil'

const	FIELD_MESSAGES = 'messages'

const	FIELD_CARTS = 'carts'

const	FIELD_SHOPPING_LISTS = 'shoppingLists'

const	FIELD_SHIPPING_RATE_INPUT_TYPE = 'shippingRateInputType'

const	FIELD_EXTERNAL_O_AUTH = 'externalOAuth'

const	FIELD_SEARCH_INDEXING = 'searchIndexing'

const	FIELD_BUSINESS_UNITS = 'businessUnits'

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 23 of file ProjectModel.php.

Constructor & Destructor Documentation

◆ __construct()

Commercetools\Api\Models\Project\ProjectModel::__construct	(	?int	$version = `null`,
		?string	$key = `null`,
		?string	$name = `null`,
		?array	$countries = `null`,
		?array	$currencies = `null`,
		?array	$languages = `null`,
		?DateTimeImmutable	$createdAt = `null`,
		?string	$trialUntil = `null`,
		?MessagesConfiguration	$messages = `null`,
		?CartsConfiguration	$carts = `null`,
		?ShoppingListsConfiguration	$shoppingLists = `null`,
		?ShippingRateInputType	$shippingRateInputType = `null`,
		?ExternalOAuth	$externalOAuth = `null`,
		?SearchIndexingConfiguration	$searchIndexing = `null`,
		?BusinessUnitConfiguration	$businessUnits = `null`
	)

@psalm-suppress MissingParamType

Definition at line 119 of file ProjectModel.php.

Member Function Documentation

◆ getBusinessUnits()

Commercetools\Api\Models\Project\ProjectModel::getBusinessUnits ( )

Holds configuration specific to Business Units.

Returns: null|BusinessUnitConfiguration

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 449 of file ProjectModel.php.

◆ getCarts()

Commercetools\Api\Models\Project\ProjectModel::getCarts ( )

Holds the configuration for the Carts feature.

Returns: null|CartsConfiguration

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 344 of file ProjectModel.php.

◆ getCountries()

Commercetools\Api\Models\Project\ProjectModel::getCountries ( )

Country code of the geographic location.

Returns: null|array

@psalm-var ?list<mixed> $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 219 of file ProjectModel.php.

◆ getCreatedAt()

Commercetools\Api\Models\Project\ProjectModel::getCreatedAt ( )

Date and time (UTC) the Project was initially created.

Returns: null|DateTimeImmutable

@psalm-var ?string $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 279 of file ProjectModel.php.

◆ getCurrencies()

Commercetools\Api\Models\Project\ProjectModel::getCurrencies ( )

Currency code of the country. A Project must have at least one currency.

Returns: null|array

@psalm-var ?list<mixed> $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 239 of file ProjectModel.php.

◆ getExternalOAuth()

Commercetools\Api\Models\Project\ProjectModel::getExternalOAuth ( )

Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.

Returns: null|ExternalOAuth

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 407 of file ProjectModel.php.

◆ getKey()

Commercetools\Api\Models\Project\ProjectModel::getKey ( )

User-defined unique identifier of the Project.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 179 of file ProjectModel.php.

◆ getLanguages()

Commercetools\Api\Models\Project\ProjectModel::getLanguages ( )

Language of the country. A Project must have at least one language.

Returns: null|array

@psalm-var ?list<mixed> $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 259 of file ProjectModel.php.

◆ getMessages()

Commercetools\Api\Models\Project\ProjectModel::getMessages ( )

Holds the configuration for the Messages Query feature.

Returns: null|MessagesConfiguration

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 323 of file ProjectModel.php.

◆ getName()

Commercetools\Api\Models\Project\ProjectModel::getName ( )

Name of the Project.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 199 of file ProjectModel.php.

◆ getSearchIndexing()

Commercetools\Api\Models\Project\ProjectModel::getSearchIndexing ( )

Controls indexing of resources to be provided on high performance read-only search endpoints.

Returns: null|SearchIndexingConfiguration

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 428 of file ProjectModel.php.

◆ getShippingRateInputType()

Commercetools\Api\Models\Project\ProjectModel::getShippingRateInputType ( )

Holds the configuration for the tiered shipping rates feature.

Returns: null|ShippingRateInputType

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 386 of file ProjectModel.php.

◆ getShoppingLists()

Commercetools\Api\Models\Project\ProjectModel::getShoppingLists ( )

Holds the configuration for the Shopping Lists feature. This field may not be present on Projects created before January 2020.

Returns: null|ShoppingListsConfiguration

@psalm-var stdClass|array<string, mixed>|null $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 365 of file ProjectModel.php.

◆ getTrialUntil()

Commercetools\Api\Models\Project\ProjectModel::getTrialUntil ( )

Date in YYYY-MM format specifying when the trial period for the Project ends. Only present on Projects in trial period.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 303 of file ProjectModel.php.

◆ getVersion()

Commercetools\Api\Models\Project\ProjectModel::getVersion ( )

Current version of the Project.

Returns: null|int

@psalm-var ?int $data

Implements Commercetools\Api\Models\Project\Project.

Definition at line 159 of file ProjectModel.php.

◆ jsonSerialize()

Commercetools\Api\Models\Project\ProjectModel::jsonSerialize ( )

Reimplemented from Commercetools\Base\BaseJsonObject.

Definition at line 587 of file ProjectModel.php.

◆ setBusinessUnits()

Commercetools\Api\Models\Project\ProjectModel::setBusinessUnits ( ?BusinessUnitConfiguration $businessUnits )

Parameters

?BusinessUnitConfiguration $businessUnits

Implements Commercetools\Api\Models\Project\Project.

Definition at line 580 of file ProjectModel.php.

◆ setCarts()

Commercetools\Api\Models\Project\ProjectModel::setCarts ( ?CartsConfiguration $carts )

Parameters

?CartsConfiguration $carts

Implements Commercetools\Api\Models\Project\Project.

Definition at line 540 of file ProjectModel.php.

◆ setCountries()

Commercetools\Api\Models\Project\ProjectModel::setCountries ( ?array $countries )

Parameters

?array $countries

Implements Commercetools\Api\Models\Project\Project.

Definition at line 492 of file ProjectModel.php.

◆ setCreatedAt()

Commercetools\Api\Models\Project\ProjectModel::setCreatedAt ( ?DateTimeImmutable $createdAt )

Parameters

?DateTimeImmutable $createdAt

Implements Commercetools\Api\Models\Project\Project.

Definition at line 516 of file ProjectModel.php.

◆ setCurrencies()

Commercetools\Api\Models\Project\ProjectModel::setCurrencies ( ?array $currencies )

Parameters

?array $currencies

Implements Commercetools\Api\Models\Project\Project.

Definition at line 500 of file ProjectModel.php.

◆ setExternalOAuth()

Commercetools\Api\Models\Project\ProjectModel::setExternalOAuth ( ?ExternalOAuth $externalOAuth )

Parameters

?ExternalOAuth $externalOAuth

Implements Commercetools\Api\Models\Project\Project.

Definition at line 564 of file ProjectModel.php.

◆ setKey()

Commercetools\Api\Models\Project\ProjectModel::setKey ( ?string $key )

Parameters

?string $key

Implements Commercetools\Api\Models\Project\Project.

Definition at line 476 of file ProjectModel.php.

◆ setLanguages()

Commercetools\Api\Models\Project\ProjectModel::setLanguages ( ?array $languages )

Parameters

?array $languages

Implements Commercetools\Api\Models\Project\Project.

Definition at line 508 of file ProjectModel.php.

◆ setMessages()

Commercetools\Api\Models\Project\ProjectModel::setMessages ( ?MessagesConfiguration $messages )

Parameters

?MessagesConfiguration $messages

Implements Commercetools\Api\Models\Project\Project.

Definition at line 532 of file ProjectModel.php.

◆ setName()

Commercetools\Api\Models\Project\ProjectModel::setName ( ?string $name )

Parameters

?string $name

Implements Commercetools\Api\Models\Project\Project.

Definition at line 484 of file ProjectModel.php.

◆ setSearchIndexing()

Commercetools\Api\Models\Project\ProjectModel::setSearchIndexing ( ?SearchIndexingConfiguration $searchIndexing )

Parameters

?SearchIndexingConfiguration $searchIndexing

Implements Commercetools\Api\Models\Project\Project.

Definition at line 572 of file ProjectModel.php.

◆ setShippingRateInputType()

Commercetools\Api\Models\Project\ProjectModel::setShippingRateInputType ( ?ShippingRateInputType $shippingRateInputType )

Parameters

?ShippingRateInputType $shippingRateInputType

Implements Commercetools\Api\Models\Project\Project.

Definition at line 556 of file ProjectModel.php.

◆ setShoppingLists()

Commercetools\Api\Models\Project\ProjectModel::setShoppingLists ( ?ShoppingListsConfiguration $shoppingLists )

Parameters

?ShoppingListsConfiguration $shoppingLists

Implements Commercetools\Api\Models\Project\Project.

Definition at line 548 of file ProjectModel.php.

◆ setTrialUntil()

Commercetools\Api\Models\Project\ProjectModel::setTrialUntil ( ?string $trialUntil )

Parameters

?string $trialUntil

Implements Commercetools\Api\Models\Project\Project.

Definition at line 524 of file ProjectModel.php.

◆ setVersion()

Commercetools\Api\Models\Project\ProjectModel::setVersion ( ?int $version )

Parameters

?int $version

Implements Commercetools\Api\Models\Project\Project.

Definition at line 468 of file ProjectModel.php.

Member Data Documentation

◆ $businessUnits

Commercetools\Api\Models\Project\ProjectModel::$businessUnits

protected

Definition at line 113 of file ProjectModel.php.

◆ $carts

Commercetools\Api\Models\Project\ProjectModel::$carts

protected

Definition at line 83 of file ProjectModel.php.

◆ $countries

Commercetools\Api\Models\Project\ProjectModel::$countries

protected

Definition at line 47 of file ProjectModel.php.

◆ $createdAt

Commercetools\Api\Models\Project\ProjectModel::$createdAt

protected

Definition at line 65 of file ProjectModel.php.

◆ $currencies

Commercetools\Api\Models\Project\ProjectModel::$currencies

protected

Definition at line 53 of file ProjectModel.php.

◆ $externalOAuth

Commercetools\Api\Models\Project\ProjectModel::$externalOAuth

protected

Definition at line 101 of file ProjectModel.php.

◆ $key

Commercetools\Api\Models\Project\ProjectModel::$key

protected

Definition at line 35 of file ProjectModel.php.

◆ $languages

Commercetools\Api\Models\Project\ProjectModel::$languages

protected

Definition at line 59 of file ProjectModel.php.

◆ $messages

Commercetools\Api\Models\Project\ProjectModel::$messages

protected

Definition at line 77 of file ProjectModel.php.

◆ $name

Commercetools\Api\Models\Project\ProjectModel::$name

protected

Definition at line 41 of file ProjectModel.php.

◆ $searchIndexing

Commercetools\Api\Models\Project\ProjectModel::$searchIndexing

protected

Definition at line 107 of file ProjectModel.php.

◆ $shippingRateInputType

Commercetools\Api\Models\Project\ProjectModel::$shippingRateInputType

protected

Definition at line 95 of file ProjectModel.php.

◆ $shoppingLists

Commercetools\Api\Models\Project\ProjectModel::$shoppingLists

protected

Definition at line 89 of file ProjectModel.php.

◆ $trialUntil

Commercetools\Api\Models\Project\ProjectModel::$trialUntil

protected

Definition at line 71 of file ProjectModel.php.

◆ $version

Commercetools\Api\Models\Project\ProjectModel::$version

protected

Definition at line 29 of file ProjectModel.php.

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

lib/commercetools-api/src/Models/Project/ProjectModel.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBusinessUnits()

◆ getCarts()

◆ getCountries()

◆ getCreatedAt()

◆ getCurrencies()

◆ getExternalOAuth()

◆ getKey()

◆ getLanguages()

◆ getMessages()

◆ getName()

◆ getSearchIndexing()

◆ getShippingRateInputType()

◆ getShoppingLists()

◆ getTrialUntil()

◆ getVersion()

◆ jsonSerialize()

◆ setBusinessUnits()

◆ setCarts()

◆ setCountries()

◆ setCreatedAt()

◆ setCurrencies()

◆ setExternalOAuth()

◆ setKey()

◆ setLanguages()

◆ setMessages()

◆ setName()

◆ setSearchIndexing()

◆ setShippingRateInputType()

◆ setShoppingLists()

◆ setTrialUntil()

◆ setVersion()

Member Data Documentation

◆ $businessUnits

◆ $carts

◆ $countries

◆ $createdAt

◆ $currencies

◆ $externalOAuth

◆ $key

◆ $languages

◆ $messages

◆ $name

◆ $searchIndexing

◆ $shippingRateInputType

◆ $shoppingLists

◆ $trialUntil

◆ $version