README

Базовый класс для работы с нерасширяемыми справочниками. Список элементов задается с помощью констант

Использование

Чтобы начать использовать функционал нерасширяемых справочников достаточно создать новый класс унаследовав его от базового.

class OrderStatus extends Enum
{
    const NEW       = 'new'; 
    const FAILED     = 'failed';
    const CANCELED   = 'canceled';
}

теперь для получения названия статуса определенного заказа вы можете использовать

echo '<p>Статус заказа: '.OrderStatus::getUiLabel($model->status).'</p>';

или например для получения списка всех возможных статусов

$statuses = OrderStatus::getUiEnums();

Список всех доступных методов вы можете посмотреть в файле Enum.php

Установка

Для того чтобы установить пакет через composer необходимо в вашем composer.json указать дополнительный источник (так как данный пакет не лежит в открытом доступе), и указать сам пакет.

...
"require": {
...
	"the-real-start/enums": "*"
}
...

Или выполнить следующую команду в командной строке:

composer require the-real-start/enums

После установки все классы расширения доступны по namespace-у TRS\Enum.

Документация

Код по возможности был хорошо задокументирован и позволяет сформировать читабельный phpdoc.

Вкратце опишу как сгенерировать документацию.

Генерация phpdoc

Комманда для геренации документации по коду:

phpdoc run -d ./ -t doc/ -i vendor/