energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: Remover

Source Location: /modules/share/components/Remover.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Component
         |
         --Remover

Класс которому передается имя компонента, который необходимо удалить Класс используется для случаев, когда пользователи с разными правми должны видеть разные компоненты


Author(s):

  • dr.Pavka

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Component

Component::__construct()
Конструктор класса.
Component::build()
Строит результат работы компонента используя определённый построитель.
Component::defineParams()
Определяет допустимые параметры компонента и их значения по-умолчанию в виде массива array(paramName => defaultValue).
Component::determineAction()
Определяет текущее действие
Component::disable()
Отключает отображение компонента
Component::enable()
Включает отображение компонента
Component::enabled()
Возвращает активность компонента
Component::generateError()
Генерирует ошибку и добавляет её в список ошибок компонента.
Component::getAction()
Определяет имя текущего действия компонента.
Component::getActionParams()
Возвращает параметры действия.
Component::getBuilder()
Возвращает построитель компонента.
Component::getMethodRights()
Возвращает уровень прав пользователя, необходимых для запуска текущего действия компонента.
Component::getName()
Возвращает имя компонента.
Component::getParam()
Возвращает значение параметра компонента, или null, если такого параметра не существует.
Component::getProperty()
Возвращает значение свойства компонента.
Component::handleErrors()
Обрабатывает ошибки, произошедшие во время работы компонента.
Component::isActive()
Возвращает флаг активности компонента
Component::main()
Действие по-умолчанию.
Component::prepare()
Метод подготовки данных.
Component::removeProperty()
Удаляет свойство компонента.
Component::run()
Запускает компонент на исполнение.
Component::setBuilder()
Устанавливает построитель компонента.
Component::setParam()
Устанавливает значение параметра компонента, если такой существует.
Component::setProperty()
Устанавливает значение свойства компонента.

Class: DBWorker

DBWorker::__construct()
Конструктор класса.
DBWorker::dateToString()
Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate()
Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString()
Возвращает дату в виде строки прописью
DBWorker::_translate()
Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 22]
Класс которому передается имя компонента, который необходимо удалить Класс используется для случаев, когда пользователи с разными правми должны видеть разные компоненты



Tags:

author:   dr.Pavka


[ Top ]


Class Methods


constructor __construct [line 33]

void __construct( string $name, string $module, Document $document, [ $params = null])

Конструктор класса.



Tags:

access:   public


Overrides Component::__construct() (Конструктор класса.)

Parameters:

string   $name  
string   $module  
Document   $document  
array   $params  

[ Top ]

method defineParams [line 43]

array defineParams( )

Добавлен параметр имя компонента



Tags:

access:   protected


Overrides Component::defineParams() (Определяет допустимые параметры компонента и их значения по-умолчанию в виде массива array(paramName => defaultValue).)

[ Top ]

method main [line 58]

void main( )

Дизейблит компонент



Tags:

access:   protected


Overrides Component::main() (Действие по-умолчанию.)

[ Top ]

В создании документации нам помог: phpDocumentor