Skip to content

def-studio/enum-features

Repository files navigation

Enum Features

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads License Twitter Follow

A simple trait to enable a feature system using Enums:

if(AppFeature::welcome_email->enabled()){
    Mail::to($newUser)->send(new WelcomeEmail($newUser));
}

Installation

You can install the package via composer:

composer require defstudio/enum-features

Usage

Features can be enabled on any enum by using the DefinesFeatures trait:

use DefStudio\EnumFeatures\EnumFeatures;

enum AppFeature
{
    use DefinesFeatures; // ← simply add this 

    case multi_language;
    case impersonate;
    case welcome_email;
}

and each feature can then added to the Laravel application in its configs/app.php file:

// config/app.php

return [
    //..
    
    'features' => [
        AppFeature::multi_language,
        AppFeature::welcome_email,
    ]
]

then, in code, a feature could be checked to be enabled:

if(AppFeature::multi_language->enabled()){
    //.. multi language specific code
}

or be disabled

if(AppFeature::impersonate->disabled()){
    throw(new Exception("Impersonate feature is not enabled"));
}

or enforced

AppFeature::impersonate->enforce(); //throws "Feature [impersonate] is not enabled"

Blade directives

In blade files, a feature can be checked with @feature directive:

@feature(AppFeature::multi_language)
<select name="language" xmlns="http://www.w3.org/1999/html">
    <option value="en">English</option>
    <option value="fr">French</option>
    <option value="it">Italian</option>
</select>
@endfeature

Customizing where and how to store enabled features

Enabled features are usually stored in config('app.features'), but this behaviour can be customized by overriding the enabledFeatures() static method inside the enum class:

use DefStudio\EnumFeatures\EnumFeatures;

enum AppFeature
{
    use DefinesFeatures; // ← simply add this 

    case multi_language;
    case impersonate;
    case welcome_email;
    
    public static function enabledFeatures(): array
    {
        return config('my_package.features', []);  //or load from DB, or every other method
    }
}

note: changing how enabled features are checked makes this package framework agnostic and it can be used in any php applicaiton

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently. Follow Us on Twitter for more updates about this package.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

Support us

We at def:studio strongly believe that open source is the foundation of all our business and we try to contribute to it by helping other projects to grow along with developing and maintaining our packages. You can support our work by sponsoring us on github!

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages