Версия: 4.x
Класс Item

Подробное описание

Класс - информация об одном модуле. + действия с модулем

Открытые члены

 __construct ($mod_name)
 
 getConfig ($site_id=null)
 
 markAsInstalled ()
 
 setUpdateTime ($time=null)
 
 getBlockControllers ()
 
 exists ()
 
 getUninstallInstance ()
 
 getInstallInstance ()
 
 getHandlersInstance ()
 
 install ($options=array())
 
 checkDependency ()
 
 uninstall ()
 
 getName ()
 
 getFolder ()
 
 initHandlers ()
 
 getTools ()
 
 issetChangelog ()
 
 getChangelog ($lang=null)
 
 getOrmObjects ()
 

Открытые статические члены

static nameByObject ($object, $default= 'main')
 
static getResourceFolders ($module_name)
 
static getBlockControllerInstance ($class_name)
 
static parseModuleXml ($file)
 

Поля данных

 $config
 
 $changelog_filename = 'changelog'
 
 $module_folder = MODULE_FOLDER
 
 $config_folder = CONFIG_FOLDER
 
 $config_class = CONFIG_CLASS
 
 $handlers_class = HANDLERS_CLASS
 
 $my_handlers_class = MY_HANDLERS_CLASS
 
 $install_class = 'install'
 
 $uninstall_class = 'uninstall'
 
 $config_prefix
 

Статические открытые данные

static $mod_js = '/modules/%MODULE%/view/js/'
 
static $mod_img = '/modules/%MODULE%/view/img/'
 
static $mod_tpl = '/modules/%MODULE%/view/'
 

Защищенные члены

 findBlockControllers ($base, $path)
 
 removeModuleFromDisk ()
 
 findOrmObjects ($base=null, $subfolder= '', $prefix=null)
 

Защищенные данные

 $mod_name
 

Статические защищенные данные

static $mod_css = '/modules/%MODULE%/view/css/'
 

Конструктор(ы)

__construct (   $mod_name)

Методы

checkDependency ( )

Проверяет зависимости модуля от ядра (core_version) и зависимость от других модулей

Возвращает
bool(true) | array Возвращает true, в случае успеха, иначе массив с ошибками
exists ( )

Возвращает true, если модуль существует, иначе - false

Возвращает
bool
findBlockControllers (   $base,
  $path 
)
protected

Рекурсивно проходит по директориям в посках блочных контроллеров

Аргументы
string$dir
Возвращает
array
findOrmObjects (   $base = null,
  $subfolder = '',
  $prefix = null 
)
protected

Возвращает список ORM объектов, находящихся в указанной папке

Аргументы
mixed$base- путь к корневой папке orm объектов
mixed$subfolder- путь к объектам, отностельно корневой папки
mixed$prefix- текст, приписываемый вначале к имени класса
static getBlockControllerInstance (   $class_name)
static

Возвращает объект класса $class_name, если класс соответствует всем требованиям блочных контроллеров иначе false

Аргументы
string$class_name
getBlockControllers ( )

Возврщает массив со списком клиентских контроллеров блоков

getChangelog (   $lang = null)

Возвращает содержимое файла changelog на языке $lang или на текущем языке

Аргументы
string$lang- двухсимвольный идентификатор языка
Возвращает
string
getConfig (   $site_id = null)

Возвращает объект - конфигурационный файл модуля

Аргументы
integer$site_id- ID сайта. Если null, то конфиг загружается для текущего сайта
Возвращает
getFolder ( )

Возвращает корневую папку модуля

Возвращает
string
getHandlersInstance ( )

Возвращает у модуля объект класса handlers

Возвращает
getInstallInstance ( )

Возвращает у модуля объект класса install

Возвращает
InstallInterface
getName ( )

Возвращает папку модуля (он же краткий символьный идентификатор)

Возвращает
string
getOrmObjects ( )

Возвращает список ORM объектов, принадлежащих данному модулю

Возвращает
array of
static getResourceFolders (   $module_name)
static

Возвращает массив относительных путей к css, js, img, tpl

Аргументы
object$objectобъект любого модуля
getTools ( )

Возвращает список действий, которые можно произвести с модулем

Возвращает
array of array

Пример стуктуры результирующего массива: array( array( 'url' => 'http://....', 'title' => 'Название' 'confirm' => 'Текст' ) )

getUninstallInstance ( )

Возвращает у модуля объект класса uninstall

Возвращает
UninstallInterface
initHandlers ( )

Инициализирует обработчики событий модуля

install (   $options = array())

Устанавливает или обновляет модуль

Аргументы
array$options- опции для установки. Массив с названиями методов класса Install модуля
Возвращает
bool(true) | array - Возвращает true в случае успеха, иначе массив с ошибками

Event: module.install.ИМЯ_МОДУЛЯ paramtype

issetChangelog ( )

Возвращает true, если у модуля есть changelog файл

Возвращает
bool
markAsInstalled ( )

Помечает модуль как установленный

Возвращает
Item
static nameByObject (   $object,
  $default = 'main' 
)
static

Возвращает сокращенной имя модуля

Аргументы
object  |  string$object- экземпляр класса модуля или имя класса модуля
mixed$default- значение, в случае, если модуль не будет распознан.
static parseModuleXml (   $file)
static

Возвращает параметры модуля по-умолчанию из XML-файла модуля. В случае ошибки, возвращает пустой массив

Аргументы
string$file- путь к файлу module.xml
Возвращает
array
removeModuleFromDisk ( )
protected

Удаляет модуль с диска

Аргументы
string$module
Возвращает
bool
setUpdateTime (   $time = null)

Устанавливает время последнего обновения модуля

Возвращает
Item
uninstall ( )

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

Возвращает
bool(true) | array - Возвращает true, в случае успеха, иначе возвращает false

Event: module.beforeUninstall.ИМЯ_МОДУЛЯ paramtype

Event: module.afterUninstall.ИМЯ_МОДУЛЯ paramtype

Поля

$changelog_filename = 'changelog'
$config
$config_class = CONFIG_CLASS
$config_folder = CONFIG_FOLDER
$config_prefix
$handlers_class = HANDLERS_CLASS
$install_class = 'install'
$mod_css = '/modules/%MODULE%/view/css/'
staticprotected
$mod_img = '/modules/%MODULE%/view/img/'
static
$mod_js = '/modules/%MODULE%/view/js/'
static
$mod_name
protected
$mod_tpl = '/modules/%MODULE%/view/'
static
$module_folder = MODULE_FOLDER
$my_handlers_class = MY_HANDLERS_CLASS
$uninstall_class = 'uninstall'