https://github.com/harness/ff-php-client-sdk
PHP Server SDK for integrating with Harness Feature Flag service.
https://github.com/harness/ff-php-client-sdk
Last synced: 11 months ago
JSON representation
PHP Server SDK for integrating with Harness Feature Flag service.
- Host: GitHub
- URL: https://github.com/harness/ff-php-client-sdk
- Owner: harness
- License: apache-2.0
- Created: 2022-05-05T18:00:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T12:01:33.000Z (almost 2 years ago)
- Last Synced: 2025-02-04T07:02:47.026Z (11 months ago)
- Language: PHP
- Size: 206 KB
- Stars: 0
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP SDK for Harness Feature Flags
========================
## Table of Contents
**[Intro](#Intro)**
**[Requirements](#Requirements)**
**[Quickstart](#Quickstart)**
**[Further Reading](docs/further_reading.md)**
**[Development](docs/development.md)**
## Intro
Use this README to get started with our Feature Flags (FF) SDK for PHP. This guide outlines the basics of getting started with the SDK and provides a full code sample for you to try out.
This sample doesn’t include configuration options, for in depth steps and configuring the SDK, for example, disabling streaming or using our Relay Proxy, see the PHP SDK Reference.
## Requirements
To use this SDK, make sure you’ve:
- installed [PHP](https://www.php.net/) 7.4 or a newer version
- installed [Composer](https://getcomposer.org/)
### General Dependencies
- [Relay Proxy](https://github.com/harness/ff-proxy)
- [Redis](https://redis.io/)
## Quickstart
To follow along with our test code sample, make sure you’ve:
- [Created a Feature Flag on the Harness Platform](https://ngdocs.harness.io/article/1j7pdkqh7j-create-a-feature-flag) called `harnessappdemodarkmode`
- [Created a server SDK key and made a copy of it](https://ngdocs.harness.io/article/1j7pdkqh7j-create-a-feature-flag#step_3_create_an_sdk_key)
-
### Install the SDK Dependency
The first step is to install the SDK as a dependency in your application using Composer.
```shell
composer require harness/ff-server-sdk
```
### Code Sample
The following is a complete code example that you can use to test the `harnessappdemodarkmode` Flag you created on the Harness Platform. When you run the code it will:
- Connect to the FF service.
- Report the value of the Flag on the webpage. Every time the `harnessappdemodarkmode` Flag is toggled on or off on the Harness Platform, the updated value will be updated when the cache refreshes, then refresh the webpage to see the new value.
- Close the SDK.
The example below can also be found in [online_example.php](https://github.com/harness/ff-php-server-sdk/raw/main/online_example.php).
```php
"harness", "identifier" => "harness"]));
$result = $client->evaluate($FLAG_NAME, false);
echo "Evaluation value for flag '".$FLAG_NAME."' with target 'harness': ".json_encode($result);
```
## Running the example with docker
This project contains the resources to quickly run this code example with Docker. To do this, you will need:
- docker
- docker-compose
- make
First set up the environment configuration for both the FF Relay Proxy and the SDK.
Copy the `.online.example.env` to `.online.env`.
```shell
cp .online.example.env .online.env
```
Then edit `.online.env` and add the following values from your Harness configuration.
```
ACCOUNT_IDENTIFIER=
ORG_IDENTIFIER=default
ADMIN_SERVICE=https://app.harness.io/gateway/cf
# You need to generate an ADMIN_SERVICE_TOKEN yourself and add it here
ADMIN_SERVICE_TOKEN=
CLIENT_SERVICE=https://config.ff.harness.io/api/1.0
AUTH_SECRET=
SDK_BASE_URL=https://config.ff.harness.io/api/1.0
SDK_EVENTS_URL=https://events.ff.harness.io/api/1.0
REDIS_ADDRESS=redis:6379
REDIS_PASSWORD=
REDIS_DB=0
# These two keys are the client and server SDK keys for your FF Environment
API_KEYS=,
```
For More information on how to get the values for these fields, refer to:
[Relay Proxy Configuration](https://ngdocs.harness.io/article/rae6uk12hk-deploy-relay-proxy#configure_relay_proxy)
[Feature Flags SDK Keys](https://ngdocs.harness.io/article/rvqprvbq8f-client-side-and-server-side-sdks)
Once these are configured, start the docker containers with:
```shell
make start
```
Once the docker containers are running, open the URL in a browser window to view the Feature Flag value.
```
http://localhost/online_example.php
```
### Additional Reading
Further examples and config options are in the further reading section:
[Further Reading](docs/further_reading.md)
-------------------------
[Harness](https://www.harness.io/) is a feature management platform that helps teams to build better software and to
test features quicker.
-------------------------