Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webinarium/php-dictionary
Static dictionary implementation for PHP.
https://github.com/webinarium/php-dictionary
dictionary php
Last synced: 12 days ago
JSON representation
Static dictionary implementation for PHP.
- Host: GitHub
- URL: https://github.com/webinarium/php-dictionary
- Owner: webinarium
- License: mit
- Created: 2016-04-19T05:10:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-07-03T11:31:16.000Z (over 3 years ago)
- Last Synced: 2024-12-29T05:36:42.335Z (about 1 month ago)
- Topics: dictionary, php
- Language: PHP
- Homepage:
- Size: 26.4 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://secure.php.net/migration74)
[](https://packagist.org/packages/webinarium/php-dictionary)
[](https://travis-ci.com/webinarium/php-dictionary)
[](https://scrutinizer-ci.com/g/webinarium/php-dictionary/?branch=master)
[](https://scrutinizer-ci.com/g/webinarium/php-dictionary/?branch=master)
# Static dictionary implementation for PHP
## Requirements
PHP needs to be a minimum version of PHP 7.4.
## Installation
The recommended way to install is via Composer:
```bash
composer require webinarium/php-dictionary
```
## Usage
To create custom dictionary you have to extend `StaticDictionary` class and override the `$dictionary` static array.
After that you can use [`StaticDictionaryInterface`](https://github.com/webinarium/php-dictionary/blob/master/src/StaticDictionaryInterface.php) to work with your dictionary.
Example dictionary:
```php
namespace Dictionary;
class Color extends StaticDictionary
{
public const BLACK = 'Black';
public const BLUE = 'Blue';
public const GREEN = 'Green';
public const CYAN = 'Cyan';
public const RED = 'Red';
public const MAGENTA = 'Magenta';
public const YELLOW = 'Yellow';
public const WHITE = 'White';
protected static array $dictionary = [
self::BLACK => '#000000',
self::BLUE => '#0000FF',
self::GREEN => '#00FF00',
self::CYAN => '#00FFFF',
self::RED => '#FF0000',
self::MAGENTA => '#FF00FF',
self::YELLOW => '#FFFF00',
self::WHITE => '#FFFFFF',
];
}
```
Input sanitizing:
```php
public function setColor($color)
{
if (Dictionary\Color::has($color)) {
$this->color = $color;
}
}
```
Symfony validation:
```php
use Symfony\Component\Validator\Constraints;
class Settings
{
/**
* @Constraints\NotNull()
* @Constraints\Choice(callback = {"Dictionary\Color", "keys"})
*/
public $color;
}
```
Symfony form:
```php
class ColorType extends AbstractType
{
/**
* {@inheritdoc}
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('color', ChoiceType::class, [
'label' => 'color',
'choices' => array_flip(Dictionary\Color::all()),
]);
}
}
```
Please note, if you try to get a value from your dictionary using non-existing key, you will get `NULL` without any failures or warnings.
Sometimes it's useful to have a default fallback value to be returned instead of `NULL`.
This can be done by defining a `FALLBACK` constant in your dictionary class:
```php
class Shell extends StaticDictionary
{
public const FALLBACK = self::UNITY;
public const XFCE = 1;
public const KDE = 2;
public const GNOME = 3;
public const LXDE = 4;
public const UNITY = 5;
public const MATE = 6;
protected static array $dictionary = [
self::UNITY => 'Unity',
self::GNOME => 'Gnome',
self::KDE => 'KDE',
self::LXDE => 'LXDE',
self::XFCE => 'Xfce',
self::MATE => 'MATE',
];
}
// This returns 'Gnome'
Shell::get(Shell::GNOME);
// This returns 'Unity'
Shell::get(Color::BLACK);
```
If your dictionary should be built in run-time, you may skip the `$dictionary` static array and overload `dictionary()` static function instead of that:
```php
class Timezone extends StaticDictionary
{
const FALLBACK = 'UTC';
protected static function dictionary(): array
{
return timezone_identifiers_list();
}
}
```
## Development
```bash
./bin/php-cs-fixer fix
XDEBUG_MODE=coverage ./bin/phpunit --coverage-text
```