Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/optimizely/php-sdk
PHP SDK for Optimizely Feature Experimentation and Optimizely Full Stack (legacy)
https://github.com/optimizely/php-sdk
optimizely-environment-prod optimizely-environment-public optimizely-owner-px
Last synced: 4 days ago
JSON representation
PHP SDK for Optimizely Feature Experimentation and Optimizely Full Stack (legacy)
- Host: GitHub
- URL: https://github.com/optimizely/php-sdk
- Owner: optimizely
- License: apache-2.0
- Created: 2016-11-21T17:30:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T16:34:52.000Z (3 months ago)
- Last Synced: 2024-12-04T06:00:26.368Z (19 days ago)
- Topics: optimizely-environment-prod, optimizely-environment-public, optimizely-owner-px
- Language: PHP
- Homepage: https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/php-sdk
- Size: 1.68 MB
- Stars: 18
- Watchers: 101
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Optimizely PHP SDK
[](https://packagist.org/packages/optimizely/optimizely-sdk)
[](https://github.com/optimizely/php-sdk/actions/workflows/php.yml?query=branch%3Amaster)
[](https://coveralls.io/github/optimizely/php-sdk?branch=master)
[](https://packagist.org/packages/optimizely/optimizely-sdk)
[](http://www.apache.org/licenses/LICENSE-2.0)
This repository houses the PHP SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy).
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).
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.
## Get Started
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.
### Requirements
To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely account executive.
SDK version 4.0.0 requires PHP8+.
SDK version 3 requires PHP5.5+ up to PHP7.
### Install the SDK
The Optimizely PHP SDK can be installed through [Composer](https://getcomposer.org/). Please use the following command:
```bash
php composer.phar require optimizely/optimizely-sdk
```
## Use the PHP SDK
### Initialization
Create the Optimizely client, for example:
```php
>);
```
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.
```php
>,
<>
);
```
To access your HTTPProjectConfigManager:
```php
configManager;
```
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
>);
$optimizely = new Optimizely(
<>,
null,
null,
null,
false,
null,
$configManager
);
```
### ProjectConfigManagerInterface
[`ProjectConfigManagerInterface`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/ProjectConfigManagerInterface.php) exposes `getConfig` method for retrieving `ProjectConfig` instance.
[`HTTPProjectConfigManager`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/HTTPProjectConfigManager.php)
is an implementation of `ProjectConfigManagerInterface` interface.
The `fetch` method makes a blocking HTTP GET request to the configured URL to download the
project datafile and initialize an instance of the ProjectConfig.
Calling `fetch` will update the internal ProjectConfig instance that will be returned by `getConfig`.
### Use HTTPProjectConfigManager
```php
>);
```
### SDK key
Optimizely project SDK key; required unless source URL is overridden.
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)`.
## SDK Development
### Unit Tests
You can run all unit tests with:
```bash
./vendor/bin/phpunit
```
### Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md).
### Other Optimizely SDKs
- Agent - https://github.com/optimizely/agent
- Android - https://github.com/optimizely/android-sdk
- C# - https://github.com/optimizely/csharp-sdk
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk
- Go - https://github.com/optimizely/go-sdk
- Java - https://github.com/optimizely/java-sdk
- JavaScript - https://github.com/optimizely/javascript-sdk
- PHP - https://github.com/optimizely/php-sdk
- Python - https://github.com/optimizely/python-sdk
- React - https://github.com/optimizely/react-sdk
- Ruby - https://github.com/optimizely/ruby-sdk
- Swift - https://github.com/optimizely/swift-sdk