Перейти к содержимому

ADR-006: Дизайн API

Принято

XOOPS должна предоставить стабильный и предсказуемый API для разработчиков модулей.

Используйте классы, методы и соглашения об именовании, которые соответствуют PHP стандартам.

  • Предсказуемость API
  • Легкость изучения
  • Совместимость с инструментами
  • Лучший код IDE
ТипСоглашениеПример
КлассыPascalCaseXoopsUser
МетодыcamelCasegetVar()
СвойстваcamelCase$userId
КонстантыUPPER_CASEXOBJ_DTYPE_INT
class XoopsUser extends XoopsObject
{
public function getVar(string $key): mixed
{
// Реализация
}
}

API дизайн обеспечивает стабильность и предсказуемость интерфейса.