Download the PHP package isap-ou/laravel-enum-helpers without Composer

On this page you can find all versions of the php package isap-ou/laravel-enum-helpers. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of isap-ou/laravel-enum-helpers

Informations about the package laravel-enum-helpers

Laravel Enum Helpers

This package brings some helpers to native PHP Enums

Laravel Enum Helpers Latest Version on Packagist Total Downloads

Installation

You can install the package via composer:

You will most likely need to edit the extensive configuration, so you can publish the config file with:

Default config

  1. enum_locations - path where enums located. Key is directory with enums, value - namespace for specified directory
  2. post_migrate - enable or disable post migrate event listener
  3. js_objects_file - path for generated js output
  4. label.prefix - get default prefix for translations of enum fields
  5. label.namespace - get default prefix for translations of enum namespace (when using as part of own package)

Available helpers

Migration helper

The way easy to add all enums to database column.

Just add to Enum trait InteractWithCollection

And in migration class

Update enum columns in DB

Artisan command allows update available(possible) values for specific enum column.

Modify enum:

And run command

There is also a listener enabled by default that will run after a successful migration. To disable it edit enum-helpers.php:

Convert PHP Enums to JS objects

Artisan command allows generate js objects based on enums

Modify enum:

And run command

Output will

You can specify output path in config enum-helpers.php

Label Helper

The Label helper allows you to transform an enum instance into a textual label, making it useful for displaying human-readable, translatable enum values in your UI.

You can retrieve a textual label for an enum case using the getLabel method:

By default, the getLabel method attempts to find a translation key, following this format: ExampleEnum.ENUM_ONE.

  1. ExampleEnum - The class name of the enum.
  2. ENUM_ONE - The enum case name.

Parameters

The getLabel method accepts three optional parameters:

  1. prefix: Prepends a prefix to the translation key.
  2. namespace: Prepends a namespace to the translation key. This is particularly useful when developing packages.
  3. locale: Allows you to specify the locale for translation. If not provided, the app’s default locale will be used.
Example with custom parameters:

This will retrieve the French (fr) translation with the specified prefix and namespace.

getLabels Method

The getLabels method returns a collection of labels for all enum cases, making it convenient to retrieve or display translatable labels for multiple enum values at once.

Customizing Prefix, Namespace, and Locale

You can customize the prefix, namespace, and locale for the translations when retrieving labels for all cases:

Global Configuration for Prefix and Namespace

You can define the prefix and namespace globally in the configuration file enum-helpers.config, or override them on the enum level by defining the following methods:

The global or per-enum configurations will be used unless you provide custom values when calling getLabel or getLabels.

Optional. Interface \IsapOu\EnumHelpers\Contracts\HasLabel for better IDE support

For better IDE support, you can implement the \IsapOu\EnumHelpers\Contracts\HasLabel interface. This helps provide autocomplete suggestions and improves code hinting for the getLabel method when working with enums.

FilamentPHP Compatibility

This helper is fully compatible with Enums in FilamentPHP

Contributing

Please, submit bugs or feature requests via the Github issues.

Pull requests are welcomed!

Thanks!

License

This project is open-sourced software licensed under the MIT License.

You are free to use, modify, and distribute it in your projects, as long as you comply with the terms of the license.

Maintained by ISAPP and ISAP OÜ.
Check out our software development services at isap.me.

All versions of laravel-enum-helpers with dependencies

PHP Build Version
Package Version
Requires illuminate/contracts Version ^9|^10|^11|^12
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package isap-ou/laravel-enum-helpers contains the following files

Loading the files please wait ....