OC3.0 разработка документации

Общее описание

Описание функций OpenCenter3.0 — это система управления, разработанная на основе ThinkPHP5.1 и LayUIAdmin. Она включает в себя функции управления администраторами и пользователями, а также управление правами и группами прав, журналом действий, системой баллов, управлением рекламой и другие функции.

Работа системы

• Требования к среде:

  • PHP >= 5.6.0 (рекомендуется версия PHP7.1 или выше);

  • MySQL >= 5.0.0 (требуется поддержка InnoDB движка);

  • Apache или Nginx;

  • PDO PHP Extension;

  • MBstring PHP Extension;

  • CURL PHP Extension.

  • Рекомендуется установить:

    • Composer — инструмент для управления сторонними пакетами.

  • Установка системы:

    • Запустите корневой каталог, который должен указывать на папку public. После доступа к веб-сайту введите соответствующие параметры для установки системы.

  Документация по базе данных

  • Путь к SQL файлам: Файлы SQL, необходимые для установки, находятся в /application/admin/command/Install/install.sql.

• Дизайн базы данных:

  • Все таблицы используют движок InnoDB;
  • Типы полей должны занимать минимальное пространство при соблюдении требований;
  • По умолчанию все таблицы имеют поля id, create_time, update_time и status;
  • Поля create_time и update_time используют int(11), а status использует tinyint(1) с диапазоном от -1 до 2.

• Содержание всех данных:

  • Таблицы данных:

  • Ключевые данные:

Документация исходного кода

Стиль написания кода: ThinkPHP5.1 следует стандартам PSR-2 и PSR-4 для именования и автоматической загрузки. Также необходимо соблюдать следующие правила:

• Каталоги и файлы:

  • Используйте строчные буквы и подчёркивание для каталогов;
  • Файлы библиотек и функций должны иметь расширение .php;
  • Имена файлов классов соответствуют определению пространства имён, и путь к файлу класса совпадает с путём к каталогу пространства имён;
  • Именование классов соответствует определению пространства имён и использует стиль CamelCase (первая буква заглавная);
  • Другие файлы используют строчные буквы и символы подчёркивания для именования.

• Функции и классы, атрибуты:

  • Именование классов следует стилю CamelCase;
  • Имена функций используют строчные буквы и символ подчёркивания;
  • Методы именуются с использованием стиля CamelCase (первая буква строчная);
  • Атрибуты именуются с использованием стиля CamelCase (первая буква строчная).

• Константы и конфигурации:

  • Константы именуются с использованием прописных букв и символа подчёркивания;
  • Параметры конфигурации именуются с использованием строчных букв и символа подчёркивания;
  • Переменные среды определяются с использованием прописных букв и символа подчёркивания.

• Таблицы данных и поля:

  • Таблицы и поля данных именуются с использованием строчных букв и символов подчёркивания, избегая использования символа подчёркивания в начале имени. Не рекомендуется использовать CamelCase и китайские иероглифы для именования таблиц и полей данных.

Рекомендуется следовать этим правилам именования для предотвращения ошибок в процессе разработки.

Структура каталогов программы: www — каталог развёртывания веб-приложения (или подкаталога): ├─application — каталог приложения: │ ├─common — каталог общего модуля (можно изменить): │ │ ├─module_name — каталог модуля: │ │ │ ├─controller — каталог контроллера; │ │ │ ├─model — каталог модели; │ │ │ ├─view — каталог представления; │ │ │ └─config — каталог конфигурации; │ │ │ │ │ ├─command.php — файл определения командной строки; │ │ ├─common.php — файл общих функций; │ │ └─tags.php — файл расширения поведения приложения; │ │ ├─config — каталог конфигурации приложения: │ ├─module_name — модуль конфигурации: │ │ ├─database.php — конфигурация базы данных; │ │ ├─cache — конфигурация кэша; │ │ └─... — дополнительные каталоги; │ | ├─route — каталог определения маршрута: │ ├─route.php — определение маршрута; │ └─... — дополнительные файлы; │ ├─public — каталог веб-доступа (каталог внешнего доступа): │ ├─index.php — входной файл; │ ├─router.php — тестовый файл быстрого доступа; │ └─.htaccess — используется для перезаписи Apache; │ ├─thinkphp — каталог системы фреймворка: │ ├─lang — каталог языковых файлов; │ ├─library — каталог библиотеки фреймворков: │ │ ├─think — пакет классов библиотеки Think; │ │ └─traits — каталог системных признаков; │ | ├─extend — каталог расширенной библиотеки классов; ├─runtime — каталог времени выполнения приложения (настраиваемый); ├─vendor — каталог сторонних библиотек (зависимость Composer); ├─build.php — автоматически генерируемый файл определения (справочный); ├─composer.json — файл определения Composer; ├─LICENSE.txt — файл лицензии; ├─README.md — файл README; ├─think — файл командной строки входа.