ADR-006: Дизайн API
Принято
Контекст
Заголовок раздела «Контекст»XOOPS должна предоставить стабильный и предсказуемый API для разработчиков модулей.
Решение
Заголовок раздела «Решение»Используйте классы, методы и соглашения об именовании, которые соответствуют PHP стандартам.
Обоснование
Заголовок раздела «Обоснование»- Предсказуемость API
- Легкость изучения
- Совместимость с инструментами
- Лучший код IDE
Соглашения
Заголовок раздела «Соглашения»| Тип | Соглашение | Пример |
|---|---|---|
| Классы | PascalCase | XoopsUser |
| Методы | camelCase | getVar() |
| Свойства | camelCase | $userId |
| Константы | UPPER_CASE | XOBJ_DTYPE_INT |
Примеры
Заголовок раздела «Примеры»class XoopsUser extends XoopsObject{ public function getVar(string $key): mixed { // Реализация }}API дизайн обеспечивает стабильность и предсказуемость интерфейса.