Skip to content

Commit dbc5153

Browse files
[FSSDK-8963] doc: Full Stack to Feature Experimentation Rename (#261)
* [FSSDK-8963] Update README.md * [FSSDK-8963] Update composer description * [FSSDK-8963] Update function docs * Update composer.json Co-authored-by: Russell Loube <[email protected]> * [FSSDK-8963] Move build badge to GitHub Actions result --------- Co-authored-by: Russell Loube <[email protected]> (cherry picked from commit e3e76b7)
1 parent fa9a3bf commit dbc5153

File tree

4 files changed

+53
-26
lines changed

4 files changed

+53
-26
lines changed

README.md

Lines changed: 50 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,43 @@
11
# Optimizely PHP SDK
2-
[![Build Status](https://travis-ci.org/optimizely/php-sdk.svg?branch=master)](https://travis-ci.org/optimizely/php-sdk)
2+
[![Packagist](https://badgen.net/packagist/v/optimizely/optimizely-sdk)](https://packagist.org/packages/optimizely/optimizely-sdk)
3+
[![Build Status](https://github.com/optimizely/php-sdk/actions/workflows/php.yml/badge.svg?branch=master)](https://github.com/optimizely/php-sdk/actions/workflows/php.yml?query=branch%3Amaster)
34
[![Coverage Status](https://coveralls.io/repos/github/optimizely/php-sdk/badge.svg?branch=master)](https://coveralls.io/github/optimizely/php-sdk?branch=master)
45
[![Total Downloads](https://poser.pugx.org/optimizely/optimizely-sdk/downloads)](https://packagist.org/packages/optimizely/optimizely-sdk)
56
[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
67

7-
This repository houses the PHP SDK for use with Optimizely Full Stack and Optimizely Rollouts.
8+
This repository houses the PHP SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy).
89

9-
Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/full-stack/docs).
10+
Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams that enables you to experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).
1011

11-
Optimizely Rollouts is free feature flags for development teams. Easily roll out and roll back features in any application without code deploys. Mitigate risk for every feature on your roadmap. Learn more at https://www.optimizely.com/rollouts/, or see the [documentation](https://docs.developers.optimizely.com/rollouts/docs).
12+
Optimizely Rollouts is [free feature flags](https://www.optimizely.com/free-feature-flagging/) for development teams. You can easily roll out and roll back features in any application without code deploys, mitigating risk for every feature on your roadmap.
1213

13-
## Getting Started
14+
## Get Started
1415

15-
### Installing the SDK
16+
Refer to the [PHP SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/php-sdk) for detailed instructions on getting started with using the SDK.
17+
18+
### Requirements
19+
20+
To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely account executive.
21+
22+
### Install the SDK
1623

1724
The Optimizely PHP SDK can be installed through [Composer](https://getcomposer.org/). Please use the following command:
1825

19-
```
26+
```bash
2027
php composer.phar require optimizely/optimizely-sdk
2128
```
2229

23-
### Feature Management Access
24-
To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely account executive.
30+
## Use the PHP SDK
2531

26-
### Using the SDK
32+
### Initialization
2733

28-
#### Initialization
2934
Create the Optimizely client, for example:
3035

3136
```php
3237
$optimizely = new Optimizely(<<DATAFILE>>);
3338
```
3439

35-
Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key, an optional fallback datafile and an optional datafile access token. Using this method internally creates an HTTPProjectConfigManager. See [HTTPProjectConfigManager](#http_config_manager) for further detail.
40+
Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key, an optional fallback datafile and an optional datafile access token. Using this method internally creates an HTTPProjectConfigManager. See [HTTPProjectConfigManager](#use-httpprojectconfigmanager) for further detail.
3641

3742
```php
3843
$optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>, <<DATAFILE_AUTH_TOKEN>>);
@@ -50,10 +55,10 @@ $configManager = new HTTPProjectConfigManager(<<SDK_KEY>>);
5055
$optimizely = new Optimizely(<<DATAFILE>>, null, null, null, false, null, $configManager);
5156
```
5257

53-
#### ProjectConfigManagerInterface
58+
### ProjectConfigManagerInterface
5459
[`ProjectConfigManagerInterface`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/ProjectConfigManagerInterface.php) exposes `getConfig` method for retrieving `ProjectConfig` instance.
5560

56-
#### <a name="http_config_manager"></a> HTTPProjectConfigManager
61+
### <a name="http_config_manager"></a> HTTPProjectConfigManager
5762

5863
[`HTTPProjectConfigManager`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/HTTPProjectConfigManager.php)
5964
is an implementation of `ProjectConfigManagerInterface` interface.
@@ -63,31 +68,53 @@ project datafile and initialize an instance of the ProjectConfig.
6368

6469
Calling `fetch` will update the internal ProjectConfig instance that will be returned by `getConfig`.
6570

66-
##### Use HTTPProjectConfigManager
71+
### Use HTTPProjectConfigManager
6772

6873
```php
6974
$configManager = new HTTPProjectConfigManager(<<SDK_KEY>>);
7075
```
7176

72-
##### SDK key
77+
### SDK key
7378
Optimizely project SDK key; required unless source URL is overridden.
7479

7580
A notification will be triggered whenever a _new_ datafile is fetched and ProjectConfig is updated. To subscribe to these notifications, use the `$notificationCenter->addNotificationListener(NotificationType::OPTIMIZELY_CONFIG_UPDATE, $updateCallback)`.
7681

77-
#### Documentation
78-
See the Optimizely Full Stack [developer documentation](https://developers.optimizely.com/x/solutions/sdks/reference/?language=php) to learn how to set up your first Full Stack project and use the SDK.
82+
## SDK Development
7983

80-
## Development
84+
### Unit Tests
8185

82-
### Unit tests
83-
84-
##### Running all tests
8586
You can run all unit tests with:
8687

87-
```
88+
```bash
8889
./vendor/bin/phpunit
8990
```
9091

9192
### Contributing
9293

9394
Please see [CONTRIBUTING](CONTRIBUTING.md).
95+
96+
### Other Optimizely SDKs
97+
98+
- Agent - https://github.com/optimizely/agent
99+
100+
- Android - https://github.com/optimizely/android-sdk
101+
102+
- C# - https://github.com/optimizely/csharp-sdk
103+
104+
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk
105+
106+
- Go - https://github.com/optimizely/go-sdk
107+
108+
- Java - https://github.com/optimizely/java-sdk
109+
110+
- JavaScript - https://github.com/optimizely/javascript-sdk
111+
112+
- PHP - https://github.com/optimizely/php-sdk
113+
114+
- Python - https://github.com/optimizely/python-sdk
115+
116+
- React - https://github.com/optimizely/react-sdk
117+
118+
- Ruby - https://github.com/optimizely/ruby-sdk
119+
120+
- Swift - https://github.com/optimizely/swift-sdk

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "optimizely/optimizely-sdk",
3-
"description": "Optimizely SDK for Full Stack PHP projects.",
3+
"description": "Optimizely PHP SDK for Optimizely Feature Experimentation, Optimizely Full Stack (legacy), and Optimizely Rollouts",
44
"keywords": ["optimizely", "sdk"],
55
"license": "Apache-2.0",
66
"authors": [

src/Optimizely/Config/DatafileProjectConfig.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class DatafileProjectConfig implements ProjectConfigInterface
7272
private $_accountId;
7373

7474
/**
75-
* @var string Project ID of the Full Stack project.
75+
* @var string Project ID of the Feature Experimentation project.
7676
*/
7777
private $_projectId;
7878

src/Optimizely/Optimizely.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ class Optimizely
116116
public $notificationCenter;
117117

118118
/**
119-
* Optimizely constructor for managing Full Stack PHP projects.
119+
* Optimizely constructor for managing Feature Experimentation PHP projects.
120120
*
121121
* @param $datafile string JSON string representing the project.
122122
* @param $eventDispatcher EventDispatcherInterface

0 commit comments

Comments
 (0)