Download the PHP package bramus/enumeration without Composer

On this page you can find all versions of the php package bramus/enumeration. 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 bramus/enumeration

Informations about the package enumeration

bramus/enumeration

Build Status Source Version Downloads License

bramus/enumeration is an Enumeration Implementation for PHP. It allows one to create both composed enumerations.

Built by Bram(us) Van Damme (https://www.bram.us) and Contributors

Prerequisites/Requirements

Installation

Installation is possible using Composer

Usage

Singular Enumerations

Creating and Playing with Instances

Converting between values and identifiers

Listing values and identifiers

Checking values and identifiers

Composed Enumerations

It's also possible to have one Enumeration be composed of several other enumerations

@note: Whilst it is technically possible to re-use the same identifiers and values throughout the classes that make up the composed Enumeration, it is discouraged to do so.

Creating and Playing with Instances

Converting between values and identifiers

Listing values and identifiers

Checking values and identifiers

Default Values

If you want, you can define a default value to use. Define it as a constant named __DEFAULT on your class and you're good to go:

The default will be used when no value is passed into the constructor:

This works both for both the Enumeration and ComposedEnumeration classes:

Summaries and Descriptions

When defining DocBlocks to go with your enumeration constants, you can get its summary and description using the getSummary() and getDescription() methods respectively.

Static methods to fetching these are also available. For each their only argument is a valid Enumeration value or a Bramus\Enumeration\Enumeration instance:

It's also possible to get a list of all summaries/descriptions. An array with the Enum values as keys is returned

Comparing Values

To compare a Bramus\Enumeration\Enumeration instance against a value, use $instance->equals()

Comparing Bramus\Enumeration\Enumeration instances against other Bramus\Enumeration\Enumeration is also possible

Utility Classes

bramus/enumeration comes with 2 utility classes. Whilst you most likely don't need to use these directly, they might be of help:

\Bramus\Enumeration\Helpers\Extractor

This class extracts constants/identifiers/values from \Bramus\Enumeration\Enumeration classes. It is used by \Bramus\Enumeration\Enumeration internally.

\Bramus\Enumeration\Helpers\Generator

This class allows one to generate instances of \Bramus\Enumeration\Enumeration classes. Given the example \Bramus\Http\StatusCodes\StatusCode class from above, its usage might be something like this:

@note: In case the Enumeration has no __DEFAULT (e.g. it is NULL), calling Generator::generate* will return a random value for the Enumeration.

Testing

bramus/enumeration ships with unit tests using PHPUnit ~8.0.

License

bramus/enumeration is released under the MIT public license. See the enclosed LICENSE for details.

All versions of enumeration with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2
bramus/reflection Version ~1.0
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 bramus/enumeration contains the following files

Loading the files please wait ....