Giter VIP home page Giter VIP logo

enum-features's Introduction

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->active()){
    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;
    
    /* Feature resolution */
    
    //with a single method:
    protected function resolve(Authenticatable $user = null) {
        match($this){
            case self::multi_language => true,
            case self::impersonate => $user->isAdmin(),
            default => false;
        }
    }
    
    //or with a dedicated method:
    
    protected function resolveImpersonate(Authenticatable $user = null){
        return $user->isSuperAdmin();
    }
}

and should be registered in your Provider

class AppServiceProvider extends ServiceProvider
{
    //..
    
    public function boot(): void {
        AppFeature::defineFeatures();
    }
}

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

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

An extensive documentation is available at

https://docs.defstudio.it/enum-features

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!

enum-features's People

Contributors

fabio-ivona avatar dependabot[bot] avatar github-actions[bot] avatar

Stargazers

Andrew G. avatar  avatar Thomas Sieffert avatar Toby Evans avatar Chrispian avatar Neil Carlo Sucuangco avatar Madalin Tache avatar kamalakar avatar Gennaro Landolfi avatar Marko avatar Roberto Butti avatar sasin91 avatar Isaac Chargoy Vivaldo avatar Anomalyce avatar Collin Henderson avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.