boing6002/helpers

Helper classes dependency for Laravel Enso

1.10.0 2019-01-13 08:03 UTC

README

Codacy Badge StyleCI License Total Downloads Latest Stable Version

Helper classes dependency for Laravel Enso.

Includes

Classes

  • An abstract Enum class which can be used to build an enumeration out of an array or a config file and comes with a set of helper functions
  • An Obj class, with a constructor for building an object from an array, a Laravel model that can even have loaded relationships and more. It provides a suite of helper functions, such as:
    • all(),
    • __toString(),
    • toJson(),
    • toArray(),
    • get($key),
    • set($key, $value),
    • has($key),
    • keys(),
    • values()
  • A JsonParser class that takes a JSON file as its constrctor's argument, and can parse and transform the file to:
    • object
    • array
    • JSON string

Exceptions

  • A generic exception: EnsoException is available also with a Facade. This exception is extended by all the other Enso specific exceptions and it is not reported by the Laravel's Exception Handler
  • A FileMissingException, a child of EnsoException
  • A JsonParseException, a child of EnsoException
  • A MorphableConfigException, a child of EnsoException

Traits

  • ActiveState - adds whereActive() and whereDisabled() scopes, isActive() and isDisabled() helpers, for models that have a boolean is_active property

Usage

Be sure to check out the full documentation for this package available at docs.laravel-enso.com

Contributions

are welcome. Pull requests are great, but issues are good too.

License

This package is released under the MIT license.