codekandis/constants-classes-translator

`codekandis/constants-classes-translator` is a library to translate values from constants classes into values of another constants classes.

2.0.0 2024-02-17 11:39 UTC

Requires

• php: >=8.3

Requires (Dev)

• codekandis/phpunit: ^5.0.0
• rector/rector: ^0.18.5
• roave/security-advisories: dev-master

MIT

• Christian Ramelow

• php
• class
• translator
• classes
• constant
• constants
• constants classes translator

README

codekandis/constants-classes-translator is a library to translate values from constants classes into values of another constants classes.

Index

• Installation
• How to use
• Exceptions

Installation

Install the latest version with

$ composer require codekandis/constants-classes-translator

How to use

Define some error codes and error messages

abstract class ErrorCodes
{
    public const int ERROR_ONE   = 1;
    public const int ERROR_TWO   = 2;
    public const int ERROR_THREE = 3;
}

abstract class ErrorMessages
{
    public const string ERROR_ONE   = 'Error one occurred.';
    public const string ERROR_TWO   = 'Error two occurred.';
    public const string ERROR_THREE = 'Error three occurred.';
}

Instantiate the ConstantsClassesTranslator

( new ConstantsClassesTranslator( ErrorCodes::class, ErrorMessages::class ) )
    ->translate( ErrorCodes::ERROR_TWO );
/**
 * Error two occured.
 */

or vice versa

( new ConstantsClassesTranslator( ErrorMessages::class, ErrorCodes::class ) )
    ->translate( ErrorMessages::ERROR_TWO );
/**
 * 2
 */

Exceptions

The ConstantsClassesTranslator throws several exceptions which inherits from ConstantsClassesTranslatorException.

• ConstantsClassNotFoundException the passed constants class name does not exist
• CorrespondingConstantsClassValueNotFoundException the constants class value has no corresponding constants class value
• ConstantsClassValueNotFoundException the constants class value does not exist