23/08
2016
Wallogit.com
2017 © Pedro Peláez
package enums
Simple php tool to work with enums
the-real-start/enums
Simple php tool to work with enums
- Tuesday, August 23, 2016
- by the-real-start
- Repository
- 1 Watchers
- 1 Stars
- 36 Installations
- PHP
- 1 Dependents
- 0 Suggesters
- 0 Forks
- 0 Open issues
- 5 Versions
- 0 % Grown
The README.md
Описание
Базовый класс для работы с нерасширяемыми справочниками. Список элементов задается с помощью констант, (*1)
Использование
Чтобы начать использовать функционал нерасширяемых справочников достаточно создать новый класс унаследовав его от базового., (*2)
class OrderStatus extends Enum
{
const NEW = 'new';
const FAILED = 'failed';
const CANCELED = 'canceled';
}
теперь для получения названия статуса определенного заказа вы можете использовать, (*3)
echo '<p>Статус заказа: '.OrderStatus::getUiLabel($model->status).'</p>';
или например для получения списка всех возможных статусов, (*4)
$statuses = OrderStatus::getUiEnums();
Список всех доступных методов вы можете посмотреть в файле Enum.php, (*5)
Установка
Для того чтобы установить пакет через composer необходимо в вашем composer.json указать дополнительный источник
(так как данный пакет не лежит в открытом доступе), и указать сам пакет., (*6)
...
"require": {
...
"the-real-start/enums": "*"
}
...
Или выполнить следующую команду в командной строке:, (*7)
composer require the-real-start/enums
После установки все классы расширения доступны по namespace-у TRS\Enum., (*8)
Документация
Код по возможности был хорошо задокументирован и позволяет сформировать читабельный phpdoc., (*9)
Вкратце опишу как сгенерировать документацию., (*10)
Генерация phpdoc
Комманда для геренации документации по коду:, (*11)
phpdoc run -d ./ -t doc/ -i vendor/
alegz