Skip to content
This repository was archived by the owner on Oct 24, 2023. It is now read-only.

Commit 24fd55d

Browse files
barbara79barbara79
authored
Merge pull request #722 from commercetools/chore-rebranding-to-composable-commerce
chore(docs): update naming to match new branding initiative
2 parents 72949dc + 2025261 commit 24fd55d

15 files changed

+49
-50
lines changed

‎CHANGELOG.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@
476476
- DoctrineCacheAdapter
477477
- NullCacheAdapter
478478
- PhpRedisCacheAdapter
479-
479+
480480
Use an appropiate PSR-6 or PRS-16 cache adapter as a replacement. The SDK uses the [cache\apcu-adapter](https://packagist.org/packages/cache/apcu-adapter) as default or if available the [cache\filesystem-adapter](https://packagist.org/packages/cache/filesystem-adapter)
481481
* Deprecations have been removed
482482
- FileRequest
@@ -490,9 +490,8 @@
490490

491491
### DEPRECATION NOTE
492492

493-
The class ```Commercetools\Commons\Helper\PriceFinder``` has been deprecated. Please use the
494-
[price selection](http://docs.commercetools.com/http-api-projects-products.html#price-selection) functionality of
495-
the platform. E.g. ```ProductProjectionSearchRequest::of()->currency('EUR')->country('DE')```
493+
The class ```Commercetools\Commons\Helper\PriceFinder``` has been deprecated. Please use the
494+
[price selection](http://docs.commercetools.com/http-api-projects-products.html#price-selection) functionality of Composable Commerce. E.g. ```ProductProjectionSearchRequest::of()->currency('EUR')->country('DE')```
496495

497496

498497
<a name="2.0.0-RC1"></a>
@@ -543,7 +542,7 @@ the platform. E.g. ```ProductProjectionSearchRequest::of()->currency('EUR')->cou
543542
```
544543
$request = ProductProjectionSearchRequest::of()->markMatchingVariants(true);
545544
```
546-
545+
547546
* PHP minimum version is now 5.6
548547
* Token caching is now using [PSR-6](https://packagist.org/providers/psr/cache-implementation) or [PSR-16](https://packagist.org/providers/psr/simple-cache-implementation) cache adapters only.
549548
Removed classes:
@@ -554,7 +553,7 @@ the platform. E.g. ```ProductProjectionSearchRequest::of()->currency('EUR')->cou
554553
- DoctrineCacheAdapter
555554
- NullCacheAdapter
556555
- PhpRedisCacheAdapter
557-
556+
558557
Use an appropiate PSR-6 or PRS-16 cache adapter as a replacement. The SDK uses the [cache\apcu-adapter](https://packagist.org/packages/cache/apcu-adapter) as default or if available the [cache\filesystem-adapter](https://packagist.org/packages/cache/filesystem-adapter)
559558
* Deprecations have been removed
560559
- FileRequest
@@ -860,53 +859,53 @@ There had been no changes
860859
* Product: renamed the ProductSetSKUAction to ProductSetSKUNotStageableAction
861860

862861
Before:
863-
862+
864863
```
865864
ProductSetSKUAction::ofVariantId()
866865
```
867866

868867
After:
869-
868+
870869
```
871870
ProductSetSKUNotStageableAction::ofVariantId() // old behavior action
872871
ProductSetSkuAction::ofVariantId() // stageable action
873872
```
874873
* Product: fix type of price collections
875-
874+
876875
Before:
877-
876+
878877
```
879878
ProductAddVariantAction::of()->setPrices(PriceCollection::of()->add(Price::of()))
880879
```
881880

882881
After:
883-
882+
884883
```
885884
ProductAddVariantAction::of()->setPrices(PriceDraftCollection::of()->add(PriceDraft::of()))
886885
```
887886
* Customer: adjust customer email verification request to API changes
888887

889888
Before:
890-
889+
891890
```
892891
CustomerEmailConfirmRequest::ofIdVersionAndToken($id, $version, $token)
893892
```
894893

895894
After:
896-
895+
897896
```
898897
CustomerEmailConfirmRequest::ofToken($token)
899898
```
900899
* Customer: adjust customer password change request to API changes
901900

902901
Before:
903-
902+
904903
```
905904
CustomerPasswordResetRequest::ofIdVersionTokenAndPassword($id, $version, $token, $newPassword)
906905
```
907906

908907
After:
909-
908+
910909
```
911910
CustomerPasswordResetRequest::ofTokenAndPassword($token, $newPassword)
912911
```
@@ -960,19 +959,19 @@ Facet, Filter, FilterRange and FilterRangeCollection in namespace Commercetools\
960959

961960
### BREAKING CHANGES
962961
* Changed named constructors for type update actions
963-
962+
964963
Before:
965-
964+
966965
```
967966
TypeAddLocalizedEnumValueAction::ofEnum(...)
968967
TypeAddEnumValueAction::ofEnum(...)
969968
TypeChangeEnumValueOrderAction::ofEnums(...)
970969
TypeChangeLocalizedEnumValueOrderAction::ofEnums(...)
971970
TypeChangeLabelAction::ofLabel(...)
972971
```
973-
972+
974973
After:
975-
974+
976975
```
977976
TypeAddLocalizedEnumValueAction::ofNameAndEnum(...)
978977
TypeAddEnumValueAction::ofNameAndEnum(...)

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# <img src="build/theme/resources/CT_cube_200px.png" width="40" align="center"></img> commercetools PHP SDK
1+
# <img src="build/theme/resources/CT_cube_200px.png" width="40" align="center"></img> Composable Commerce PHP SDK
22

3-
:warning: **This commercetools PHP SDK is in its Active Support mode currently, and is planned to be deprecated, please note the following dates.
3+
:warning: **This Composable Commerce PHP SDK is in its Active Support mode currently, and is planned to be deprecated, please note the following dates.
44

55
| Active Support | Maintenance Support | End of Life |
66
| --------------------- | --------------------- | --------------------- |
@@ -10,7 +10,7 @@ We recommend to use our [PHP SDK V2](https://docs.commercetools.com/sdk/php-sdk#
1010

1111
[![Build Status](https://img.shields.io/travis/com/commercetools/commercetools-php-sdk/master.svg?style=flat-square)](https://travis-ci.com/commercetools/commercetools-php-sdk) [![Scrutinizer](https://img.shields.io/scrutinizer/g/commercetools/commercetools-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/commercetools/commercetools-php-sdk/) [![Scrutinizer](https://img.shields.io/scrutinizer/coverage/g/commercetools/commercetools-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/commercetools/commercetools-php-sdk/) [![Packagist](https://img.shields.io/packagist/v/commercetools/php-sdk.svg?style=flat-square)](https://packagist.org/packages/commercetools/php-sdk) [![Packagist](https://img.shields.io/packagist/dm/commercetools/php-sdk.svg?style=flat-square)](https://packagist.org/packages/commercetools/php-sdk)
1212

13-
The PHP SDK allows developers to build applications on the commercetools platform (technically speaking against our REST API) using PHP native interfaces, models and helpers instead of manually using the HTTP and JSON API.
13+
The PHP SDK allows developers to integrate with Composable Commerce APIs using PHP native interfaces, models and helpers instead of manually using the HTTP and JSON API.
1414

1515
You gain lots of IDE Auto-Completion, type checks on a literal API, Warnings, Object Mapping, i18n support etc.. The Client manages the OAuth2 security tokens, provides caches and interfaces for concurrent and asynchronous API calls.
1616

@@ -70,7 +70,7 @@ Please read the [Changelog](CHANGELOG.md) before updating in any case.
7070

7171
### Getting started
7272

73-
To get up and running, create a free test project ([EU located](https://mc.commercetools.com/login/new) or [US located](https://mc.commercetools.co/login/new)) on the commercetools platform. To generate your API credentials go to [EU Merchant Center](https://mc.commercetools.com/) or [US Merchant Center](https://mc.commercetools.co/) (Menu "Settings"->"Developer Settings"->"API Clients"->"Create New Api Client").
73+
To get up and running, create a free test [Project](https://mc.commercetools.com/login/new) on Composable Commerce. You can create your first API Client in [The Merchant Center](https://mc.commercetools.com/) (Menu "Settings"->"Developer settings"->"Create new API client").
7474
You need to select the template for the "Admin client".
7575

7676
```php
@@ -234,7 +234,7 @@ $client = ClientFactory::of()->createClient($config, $logger, $cache);
234234

235235
#### Middlewares
236236

237-
Adding middlewares to the clients for platform as well for the authentication can be done using the config
237+
Adding middlewares to the clients for Composable Commerce as well for the authentication can be done using the config
238238
by setting client options.
239239

240240
For using a custom HandlerStack
@@ -344,7 +344,7 @@ $response = $client->execute($request);
344344
$project = $request->mapFromResponse($response);
345345
var_dump($project->toArray());
346346
```
347-
347+
348348
## Improve & Contribute to the SDK project
349349

350350
### Mac OS X preparations:
@@ -419,7 +419,7 @@ Now you can enable at Preferences > Editor > Inspections > PHP the "PHP code sni
419419

420420
### Running integration tests
421421

422-
For running the integration tests you need an empty commercetools project and have to create an API client using the commercetools Merchant Center with the scopes:
422+
For running the integration tests you need an empty Project and have to create an API client using the commercetools Merchant Center with the scopes:
423423
```
424424
manage_project
425425
view_orders

‎build/theme/@layout.latte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<nav id="navigation" class="navbar navbar-default navbar-fixed-top">
2828
<div class="container-fluid">
2929
<div class="navbar-header">
30-
<a href="index.html" class="navbar-brand"><img src="{='resources/ct-logo.svg'|staticFile}" id="navbar-logo" alt="commercetools platform PHP SDK">{if $config->title}{$config->title} {getenv('SDK_VERSION')}{else}Overview{/if}</a>
30+
<a href="index.html" class="navbar-brand"><img src="{='resources/ct-logo.svg'|staticFile}" id="navbar-logo" alt="Composable Commerce PHP SDK">{if $config->title}{$config->title} {getenv('SDK_VERSION')}{else}Overview{/if}</a>
3131
</div>
3232
<div class="collapse navbar-collapse">
3333

‎docroot/factory.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
?>
5858
<html>
5959
<head>
60-
<title>Commercetools PHP SDK example</title>
60+
<title>Composable Commerce PHP SDK example</title>
6161
</head>
6262
<body>
6363
<form method="POST" action=".">

‎docroot/index.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
?>
5656
<html>
5757
<head>
58-
<title>Commercetools PHP SDK example</title>
58+
<title>Composable Commerce PHP SDK example</title>
5959
</head>
6060
<body>
6161
<form method="POST" action=".">

‎docroot/myapp.yml.dist

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
parameters:
2-
client_id: Your Commercetools client ID
3-
client_secret: Your Commercetools client secret
4-
project: Your Commercetools project key
2+
client_id: Your Composable Commerce client ID
3+
client_secret: Your Composable Commerce client secret
4+
project: Your Composable Commerce project key

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "commercetools-php-sdk-changelog",
33
"version": "2.19.0",
4-
"description": "commercetools PHP SDK changelog generator package description",
4+
"description": "Composable Commerce PHP SDK changelog generator package description",
55
"homepage": "https://github.com/commercetools/commercetools-php-sdk",
66
"bugs": "https://github.com/commercetools/commercetools-php-sdk/issues",
77
"license": "MIT",

‎src/Commons/Helper/PriceFinder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
use Commercetools\Core\Model\CustomerGroup\CustomerGroupReference;
1212

1313
/**
14-
* @deprecated Please use the price selection functionality of the platform
14+
* @deprecated Please use the price selection functionality of Composable Commerce
1515
* @link http://docs.commercetools.com/http-api-projects-products.html#price-selection
1616
*/
1717
class PriceFinder

‎src/Core/Client.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
use function GuzzleHttp\Psr7\stream_for;
2929

3030
/**
31-
* The client for communicating with the commercetools platform
31+
* The client for communicating with Composable Commerce
3232
*
3333
* @description
3434
* ## Instantiation

‎src/Core/Client/ClientFactory.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@
3232
use Psr\SimpleCache\CacheInterface;
3333

3434
/**
35-
* The factory to create a Client for communicating with the commercetools platform
35+
* The factory to create a Client for communicating with Composable Commerce
3636
*
3737
* @description
38-
* This factory will create a Guzzle HTTP Client preconfigured for talking to the commercetools platform
38+
* This factory will create a Guzzle HTTP Client preconfigured for talking to Composable Commerce
3939
*
4040
* ## Instantiation
4141
*
@@ -137,7 +137,7 @@
137137
*
138138
* ## Middlewares
139139
*
140-
* Adding middlewares to the clients for platform as well for the authentication can be done using the config
140+
* Adding middlewares to the clients for Composable Commerce as well for the authentication can be done using the config
141141
* by setting client options.
142142
*
143143
* ### Using a HandlerStack

‎src/Core/Error/ConcurrentModificationException.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
* Exeption for response with status code 409
1010
* @package Commercetools\Core\Error
1111
* @description
12-
* When trying to update a resource with a version which differs from the version stored at the commercetools
13-
* platform the API will respond with status code 409.
12+
* When trying to update a resource with a version which differs from the version stored on Composable Commerce,
13+
* the API will respond with status code 409.
1414
*/
1515
class ConcurrentModificationException extends ClientErrorException
1616
{

‎src/Core/Error/ServiceUnavailableException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Exception for response with status code 503
1010
* @package Commercetools\Core\Error
1111
* @description
12-
* The commercetools platform is currently not available
12+
* Composable Commerce is currently not available
1313
*/
1414
class ServiceUnavailableException extends ServerErrorException
1515
{

‎src/Core/Request/Orders/Command/OrderAddDeliveryAction.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public static function ofDeliveryItems(DeliveryItemCollection $items, $context =
6262
}
6363

6464
/**
65-
* @deprecated not supported by platform - will be removed in 3.0
65+
* @deprecated not supported by Composable Commerce - will be removed in 3.0
6666
* @return null
6767
*/
6868
public function getMeasurements()
@@ -71,7 +71,7 @@ public function getMeasurements()
7171
}
7272

7373
/**
74-
* @deprecated not supported by platform - will be removed in 3.0
74+
* @deprecated not supported by Composable Commerce - will be removed in 3.0
7575
* @return OrderAddDeliveryAction
7676
*/
7777
public function setMeasurements()
@@ -80,7 +80,7 @@ public function setMeasurements()
8080
}
8181

8282
/**
83-
* @deprecated not supported by platform - will be removed in 3.0
83+
* @deprecated not supported by Composable Commerce - will be removed in 3.0
8484
* @return null
8585
*/
8686
public function getTrackingData()
@@ -89,7 +89,7 @@ public function getTrackingData()
8989
}
9090

9191
/**
92-
* @deprecated not supported by platform - will be removed in 3.0
92+
* @deprecated not supported by Composable Commerce - will be removed in 3.0
9393
* @return OrderAddDeliveryAction
9494
*/
9595
public function setTrackingData()

‎src/Core/Request/Products/Command/ProductSetTaxCategoryAction.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public function __construct(array $data = [], $context = null)
3838
}
3939

4040
/**
41-
* @deprecated not supported by platform - will be removed in 3.0
41+
* @deprecated not supported by Composable Commerce - will be removed in 3.0
4242
* @return null
4343
*/
4444
public function getStaged()
@@ -47,7 +47,7 @@ public function getStaged()
4747
}
4848

4949
/**
50-
* @deprecated not supported by platform - will be removed in 3.0
50+
* @deprecated not supported by Composable Commerce - will be removed in 3.0
5151
* @return ProductSetTaxCategoryAction
5252
*/
5353
public function setStaged()

‎tests/myapp.yml.dist

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
parameters:
2-
client_id: Your Commercetools client ID
3-
client_secret: Your Commercetools client secret
4-
project: Your Commercetools project key
2+
client_id: Your Composable Commerce client ID
3+
client_secret: Your Composable Commerce client secret
4+
project: Your Composable Commerce Project key
55
oauth_url: https://auth.europe-west1.gcp.commercetools.com
66
api_url: https://api.europe-west1.gcp.commercetools.com
77
enableCorrelationId: 1

0 commit comments

Comments
 (0)