From 962f0919405f1660132a2c0e6324edb146d4b293 Mon Sep 17 00:00:00 2001 From: Owais Akbani <owais.akbani92@gmail.com> Date: Mon, 6 Apr 2020 19:51:10 +0500 Subject: [PATCH 1/4] docs: Add steps for sdk key init --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7feae57..970e6cb4 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,17 @@ Create the Optimizely client, for example: $optimizely = new Optimizely(<<DATAFILE>>); ``` -You can also provide an implementation of the `ProjectConfigManagerInterface` in the constructor: +Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTProjectConfigManager. See HTTProjectConfigManager for further detail. + +``` +$optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>); +``` +// access your HTTP project config manager +``` +$configManager = $optimizelyClient->configManager; +``` + +Or you can also provide an implementation of the `ProjectConfigManagerInterface` in the constructor: ``` $configManager = new HTTPProjectConfigManager(<<SDK_KEY>>); From 7354591c6e1adb19a7e1a177ebc6607b13f6b801 Mon Sep 17 00:00:00 2001 From: Owais Akbani <owais.akbani92@gmail.com> Date: Mon, 6 Apr 2020 19:53:36 +0500 Subject: [PATCH 2/4] docs: fix http config manager spell --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 970e6cb4..00b02cb8 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,12 @@ Create the Optimizely client, for example: $optimizely = new Optimizely(<<DATAFILE>>); ``` -Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTProjectConfigManager. See HTTProjectConfigManager for further detail. +Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTPProjectConfigManager. See HTTPProjectConfigManager for further detail. ``` $optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>); ``` -// access your HTTP project config manager +// access your HTTPProjectConfigManager ``` $configManager = $optimizelyClient->configManager; ``` From 4b48e5f40d1421e0c208121d57fb92330aead376 Mon Sep 17 00:00:00 2001 From: Owais Akbani <owais.akbani92@gmail.com> Date: Wed, 8 Apr 2020 12:37:19 +0500 Subject: [PATCH 3/4] nits --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 00b02cb8..2f1ed580 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Optimizely Rollouts is free feature flags for development teams. Easily roll out The Optimizely PHP SDK can be installed through [Composer](https://getcomposer.org/). Please use the following command: -``` +```sh php composer.phar require optimizely/optimizely-sdk ``` @@ -28,23 +28,24 @@ To access the Feature Management configuration in the Optimizely dashboard, plea #### Initialization Create the Optimizely client, for example: -``` +```php $optimizely = new Optimizely(<<DATAFILE>>); ``` -Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTPProjectConfigManager. See HTTPProjectConfigManager for further detail. +Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTPProjectConfigManager. See [HTTPProjectConfigManager](#http_config_manager) for further detail. -``` +```php $optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>); ``` -// access your HTTPProjectConfigManager -``` +To access your HTTPProjectConfigManager + +```php $configManager = $optimizelyClient->configManager; ``` -Or you can also provide an implementation of the `ProjectConfigManagerInterface` in the constructor: +Or you can also provide an implementation of the [`ProjectConfigManagerInterface`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/ProjectConfigManagerInterface.php) in the constructor: -``` +```php $configManager = new HTTPProjectConfigManager(<<SDK_KEY>>); $optimizely = new Optimizely(<<DATAFILE>>, null, null, null, false, null, $configManager); ``` @@ -52,7 +53,7 @@ $optimizely = new Optimizely(<<DATAFILE>>, null, null, null, false, null, $confi #### ProjectConfigManagerInterface [`ProjectConfigManagerInterface`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/ProjectConfigManagerInterface.php) exposes `getConfig` method for retrieving `ProjectConfig` instance. -#### HTTPProjectConfigManager +#### <a name="http_config_manager"></a> HTTPProjectConfigManager [`HTTPProjectConfigManager`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/HTTPProjectConfigManager.php) is an implementation of `ProjectConfigManagerInterface` interface. @@ -64,7 +65,7 @@ Calling `fetch` will update the internal ProjectConfig instance that will be ret ##### Use HTTPProjectConfigManager -``` +```php $configManager = new HTTPProjectConfigManager(<<SDK_KEY>>); ``` @@ -83,7 +84,7 @@ See the Optimizely Full Stack [developer documentation](https://developers.optim ##### Running all tests You can run all unit tests with: -``` +```sh ./vendor/bin/phpunit ``` From 41f1dcf0dd9a23d05764484d5b9d21872a02a4e7 Mon Sep 17 00:00:00 2001 From: Owais Akbani <owais.akbani92@gmail.com> Date: Wed, 8 Apr 2020 12:41:55 +0500 Subject: [PATCH 4/4] cleanup --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f1ed580..fcd3c9f1 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Optimizely Rollouts is free feature flags for development teams. Easily roll out The Optimizely PHP SDK can be installed through [Composer](https://getcomposer.org/). Please use the following command: -```sh +``` php composer.phar require optimizely/optimizely-sdk ``` @@ -37,7 +37,7 @@ Or you may also use OptimizelyFactory method to create an optimizely client usin ```php $optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>); ``` -To access your HTTPProjectConfigManager +To access your HTTPProjectConfigManager: ```php $configManager = $optimizelyClient->configManager; @@ -84,7 +84,7 @@ See the Optimizely Full Stack [developer documentation](https://developers.optim ##### Running all tests You can run all unit tests with: -```sh +``` ./vendor/bin/phpunit ```