How to Use a PHP base62 Encode and Decode Class as a Service for Laravel Applications with the Package Laravel Encoder: Encode and decode string with custom base encoding

$encoder = new Encoder('base62', $config);

// $length refers to the index (0-based), not the key $customEncodedId = $encoder->encodeId(12345, 3);

echo "Custom Encoded ID: $customEncodedId\n"; // qVX

#### Important Notes:
1. The `$length` parameter represents the index in the configuration array, not the key value.
2. It must always be smaller than the highest index of the configuration array.
3. For example, in the above `$config`, the valid values for `$length` are `0`, `1`, `2`, `3`, or `4` (total of 5 elements, indices `0?4`).
### Encoder Configuration File
Note: This configuration file is applicable only when using the package with a Laravel application.
For standalone usage, you need to provide configuration directly while initializing the `Encoder` class.
This file allows you to set up the default base encoder and customize its behavior within Laravel.
By default, the package uses the `base62` encoder, but you can define additional configurations
for Base62 or other custom Base classes that you may add via the Factory.
### Default Base62 Configuration
If you are using the default Base62 implementation, you can override its default mappers
by specifying custom mappings in the `config` array below. These mappers are used to obfuscate
the encoding process by applying prime numbers for variable-length encoding.
Example for overriding Base62 mappers:

'config' => [

1 => '1',
5 => '41',
6 => '2377',
7 => '147299',
8 => '9132313',

],

### Usage in Laravel
To publish this configuration file, run the following command:

php artisan vendor:publish --provider="Nassiry\Encoder\EncoderServiceProvider"

After publishing, you can modify the configuration to suit your application's needs.
### Custom Bases: Add Your Own Encoding Scheme
  - If you are implementing your own Base class (Base58 or Base64):
  - Implement the `BaseEncoderInterface` in your class.
  - Add your custom base to the `BaseFactory`.
  -  Use this `config` array to define any specific configuration required for your custom base.

use Nassiry\Encoder\Bases\BaseEncoderInterface;

class Base58 implements BaseEncoderInterface {

public function encodeId(int|string $id, int $length): string
{
    // Implement encoding logic for Base58
}

public function decodeId(string $hashed): string
{
    // Implement decoding logic for Base58
}

public function encodeString(string $string): string;
{
    // Implement encoding logic for Base58
}

public function decodeString(string $encoded): string;
{
    // Implement decoding logic for Base58
}

}

### Register the new base in the `BaseFactory` - `create` method:

return match (strtolower($base)) {

'base62' => new Base62($config),
'base58' => new Base58($config),  // Register Base58 here
default => throw EncoderException::unsupportedBase($base),

};

### Use your custom base like this:

use Nassiry\Encoder\Encoder;

$encoder = new Encoder('base58');

$encodedId = $encoder->encodeId(12345); echo "Base58 Encoded ID: $encodedId\n";

$decodedId = $encoder->decodeId($encodedId); echo "Decoded ID: $decodedId\n";

### Handling Exceptions
The package throws meaningful exceptions for invalid input and other runtime issues, making it easier to debug and handle errors gracefully.
The `EncoderException` class extends PHP's `RuntimeException` and provides static methods for creating specific exceptions.
#### Common Exceptions
- Invalid ID: Thrown when an ID is not a valid non-negative integer.
- Invalid Length: Thrown when length is not a valid non-negative integer.
- Empty Input: Thrown when the input string is empty.
- Invalid Base String: Thrown when a string contains invalid characters for the base.
- Invalid Base: Thrown when a base (Base58 or Base64) is not registered in the Factory.
- Invalid Method Call: Thrown when an undefined method is called on a base encoder.
- Invalid Class: Thrown when a custom base class does not implement the required `BaseEncoderInterface`.

EncoderException::invalidId(); // Message: "The ID must be a non-negative integer."

EncoderException::invalidLength($length); // Message: "The length must be greater than zero. Given: 0"

EncoderException::emptyInput(); // Message: "Input string cannot be empty."

EncoderException::invalidBaseString(string $char, string $base); // Message: "Invalid character '!' in 'base62' string."

EncoderException::invalidBase(string $base); // Message: "Encoder base 'base64' is not supported."

EncoderException::invalidMethod(string $method); // Message: "Method 'fooBar' does not exist on the base encoder."

EncoderException::invalidClass(string $className); // Message: "Class 'MyBaseEncoder' must implement BaseEncoderInterface."

#### Example: Catching Exceptions
You can wrap your encoding/decoding logic in a `try-catch` block to handle exceptions gracefully:

use Nassiry\Encoder\Exceptions\EncoderException;

try {

$encoded = $encoder->encodeId(-1); // Invalid ID

} catch (EncoderException $e) {

echo "Error: " . $e->getMessage();

}

### Testing
To ensure the package functions as expected and meets all requirements, you can run the included tests. Follow the steps below to execute the test suite:
#### Prerequisites
1. Ensure you have all dependencies installed by running:

composer install

2. Verify that the required PHP extensions (`bcmath` and `mbstring`) are enabled.
#### Running Tests
Execute the following command to run the test suite:

composer test

#### Test Coverage
The package comes with extensive test coverage for encoding and decoding methods, exception handling, and configuration. This ensures robust behavior across various use cases.
#### Contributing to Tests
If you encounter a bug or add a new feature, consider writing or updating the tests. Use the following guidelines:
1. Add your test cases to the appropriate files in the `tests` directory.
2. Follow the `PSR-12` coding standards for consistency.
3. Run `composer test` again to verify that all tests pass before submitting a pull request.
### Why Base62?
Why Base62?
### Conclusion: Why Choose This Package?
Conclusion
### Contributing
Feel free to submit issues or pull requests to improve the package. Contributions are welcome!

### License
This package is open-source software licensed under the MIT license.