Класс Module

Класс Module предназначен для работы с установленными модулями. Этот класс содержит только статические методы и доступен в любом месте выполнения.

Методы Module

Module::exists($module)

Проверяет существование модуля $module

Пример

<?php
if(Module::exists('chat')){
// Модуль чата существует
}
?>

Проверяется наличие папки модуля. Если папка существует, то и модуль считается существующим, даже если папка пустая.

Module::delete($module)

Удаляет модуль

Module::config($module)

Возвращает настройки модуля. Настройки модуля хранятся в ini файле в папке модуля. Файл настроек может иметь имя config.ini или info.ini.

Пример файла ini

name = "Captcha"
version = "1.2"
developer = "MyEngine CMS"
site = "my-engine.ru"
delete = 0
description = "<p>Вставляет проверочную картинку защиты от спама</p>" 
version_history["1.2"] = "<p>Улучшена производительность</p>"
version_history["1.1"] = "<p>Добавлены новые фоны картинки</p>"

Доступные параметры config.ini:

name - Название модуля.
version - Номер версии.
developer - Имя или копирайт разработчика.
site - Сайт разработчика (указывается без http://).
description - Описание модуля. Выводится на странице модуля в панели администратора. Текст описания следует заключать в html тег P.
delete - Запрет на удаление модуля. Если установить значение 0, то удалить модуль, через панель управления, будет невозможно. Значение по умолчанию - 1.
gorizont_menu - Позволяет скрыть возможность редактирование главного меню. Если установить значение 0, то редактирование главного меню будет невозможно.
left_menu - Позволяет скрыть возможность редактирование левой колонки. Если установить значение 0, то редактирование левой колонки будет невозможно.
right_menu - Позволяет скрыть возможность редактирование правой колонки. Если установить значение 0, то редактирование правой колонки будет невозможно.
indexname - Имя отображаемой иконки на главной странице панели администратора.
version_history["x.x"] - Описание истории версий модуля. Отображается на странице модуля в панели администратора. Текст описания следует заключать в html тег P. (Там где x.x - это номер версии)

Module::isWysiwyg($module)

Проверяет, является ли модуль редактором страниц. Проверяется наличие файла wysiwyg.php в папке модуля.

Module::isTemlate($module)

Проверяет, является ли модуль шаблоном. Проверяется наличие файла template.php в папке модуля.

Module::skrTemlate($module)

Возвращает путь до скриншота шаблона. Проверяется наличие файла skr.png в папке модуля. Если файл скриншота присутствует, то метод вернет его полный путь.

Module::isAdminPage($module)

Проверяет, есть ли у модуля веб интерфейс. Проверяется наличие файла admin.php в папке модуля.

Module::icon($module))

Возвращает путь до иконки модуля. Проверяется наличие файла icon.png в папке модуля. Если файл иконка присутствует, то метод вернет её полный путь.

Module::isIntegrationPage($module)

Проверяет, может ли модуль интегрироваться в страницы. Проверяется наличие файла integration_page.php в папке модуля.

Module::isIntegrationBlok($module)

Проверяет, может ли модуль интегрироваться боковые блоки. Проверяется наличие файла integration_blok.php в папке модуля.

Module::isIntegrationPages($module)

Проверяет, может ли модуль интегрироваться во все страницы сайта. Проверяется наличие файла integration_pages.php в папке модуля.

Module::isIntegrationAdminIndex($module)

Проверяет, может ли модуль интегрироваться в главную страницу панели администратора. Проверяется наличие файла integration_admin.php в папке модуля.

Module::isIntegrationSystem($module)

Проверяет, может ли модуль интегрироваться в начало выполнения всех страниц. Проверяется наличие файла integration_system.php в папке модуля.

Module::isIntegrationEnd($module)

Проверяет, может ли модуль интегрироваться в конец выполнения всех страниц. Проверяется наличие файла integration_end.php в папке модуля.