README

This library helps with integrating Zenmanage into Laravel applications.

Installation

This library can be installed via Composer:

composer require zenmanage/zenmanage-laravel

Publish the config

Run the following command to publish the package config file:

php artisan vendor:publish --provider="Zenmanage\Laravel\ZenmanageServiceProvider"

You should now have a config/zenmanage.php file that allows you to configure the basics of this package.

Configuration

The only required configuration is the Environment Token. You can get your Environment Token via the Project settings in your Zenmanage account.

Configuration values are set in the config/zenmanage.php file.

ZENMANAGE_ENVIRONMENT_TOKEN=tok_sample

Context

When retrieving values for feature flags, a context can be provided that can change the value based on unique attributes of the context.

use \Zenmanage\Flags\Request\Entities\Context\Attribute;
use \Zenmanage\Flags\Request\Entities\Context\Context;
use \Zenmanage\Flags\Request\Entities\Context\Value;
use \Zenmanage\Laravel\Services\DirectClient as Client;

$context = new Context('user', 'John Doe', 'id-123', [
    new Attribute('company', [
        new Value('JD, Inc.'),
    ]),
]);

$zenmanage = (new Client())
    ->withContext($context);

Default Values

When retrieving values for feature flags, a default value will be returned to the application if the Zenmanage API is unavailable or responds incorrectly. This will ensure your app will still function in the event that a flag cannot be evaluated.

use \Zenmanage\Laravel\Services\DirectClient as Client;

$zenmanage = (new Client())
    ->withDefault('flag-key', 'boolean', false);

Retrieving a Feature Flag Value

Before retrieving a feature flag, create a new instance of Zenmanage. If you configured your environment token key via environment variables there's nothing to add. Otherwise, see the example above.

use \Zenmanage\Laravel\Services\DirectClient as Client;

$zenmanage = new Client();

Retrieving Flags

All Flags

$results = $zenmanage->all();

foreach ($results as $results) {
    $key = $result->key;
    $name = $result->name;
    $type = $result->type;
    $value = $result->value
}

Single Flag

$result = $zenmanage->single('flag-key');

$key = $result->key;
$name = $result->name;
$type = $result->type;
$value = $result->value

Reporting Feature Flag Usage

When your application uses a feature flag, it can notify Zenmanage of the usage. This helps Zenmanage determine which flags are active and which may have been abandoned.

$zenmanage->report('flag-key');

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/zenmanage/zenmanage-laravel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The library is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Zenmanage's code bases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

What is Zenmanage?

Zenmanage allows you to control which features and settings are enabled in your application giving you better flexibility to deploy code and release features.

Zenmanage was started in 2024 as an alternative to highly complex feature flag tools. Learn more about us.

zenmanage / zenmanage-laravel

Maintainers

Details