Download the PHP package mudandstars/sync-enum-types without Composer

On this page you can find all versions of the php package mudandstars/sync-enum-types. 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 mudandstars/sync-enum-types

Informations about the package sync-enum-types

This is my package sync-enum-types

Latest Version on Packagist GitHub Tests Action Status Total Downloads

This package ships a command that creates typescript declaration files for your php Enums. This command can be set so it automatically runs on-save, for example.

Installation

You can install the package via composer:

Usage (VS Code)

  1. Check if the published config needs changes, based on your project structure
  2. Install the 'Run on Save' Extension
  3. Add the 'Run on Save' command to your settings.json (I like the workspace settings for this):

Configuration

You can publish the config file with:

The recommended config has SYNC_CASES set to true to provide the enum cases as typed array for use in the frontend. Its latest version looks like this:

Possible Enum Features and Flags

Using Custom Method's Description

To avoid conflicts with existing data when changing Enum values in your database, some engineers prefer to use simple integers as their values and make use of functions to describe what the values represent, like the following:

If you want to sync the descriptions from an Enum's method instead of its cases' values, put the sync-using-method flag above the corresponding function like so:

Linking Other Enums

To maintain a single source of truth when using many Enums, sometimes it is necessary to define a case like this:

This is automatically handled correctly and resolves the value of the other Enum, as long as its source file also resides in the same directory.

Changelog

Please see CHANGELOG for more information on what has changed recently.

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.

All versions of sync-enum-types with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
spatie/laravel-package-tools Version ^1.14.0
illuminate/contracts Version ^10.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 mudandstars/sync-enum-types contains the following files

Loading the files please wait ....