Download the PHP package agence-adeliom/easy-common-bundle without Composer

Easy Common Bundle

Provide base utilities for Easyadmin.

Features

• A Enum polyfill for PHP 8 (< 8.1.0)
• Some Traits for entities

Versions

Installation

Install with composer

Traits

• ID
• Name and Slug
• Name
• Publishable
• Status
• Three State Status
• Timestampable
• Soft Deletable

Enum helper

Declaration

Usage

As you can see, static methods are automatically implemented to provide quick access to an enum value.

One advantage over using class constants is to be able to use an enum as a parameter type:

Documentation

• __construct() The constructor checks that the value exist in the enum
• __toString() You can echo $myValue, it will display the enum value (value of the constant)
• getValue() Returns the current value of the enum
• getKey() Returns the key of the current value on Enum
• equals() Tests whether enum instances are equal (returns true if enum values are equal, false otherwise)

Static methods:

• from() Creates an Enum instance, checking that the value exist in the enum
• toArray() method Returns all possible values as an array (constant name in key, constant value in value)
• keys() Returns the names (keys) of all constants in the Enum class
• values() Returns instances of the Enum class of all Enum constants (constant name in key, Enum instance in value)
• isValid() Check if tested value is valid on enum set
• isValidKey() Check if tested key is valid on enum set
• assertValidValue() Assert the value is valid on enum set, throwing exception otherwise
• search() Return key for searched value

Static methods

Static method helpers are implemented using __callStatic().

If you care about IDE autocompletion, you can either implement the static methods yourself:

or you can use phpdoc (this is supported in PhpStorm for example):

License

MIT

Authors

• @arnaud-ritti