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

Class: ComponentManager

Source Location: /framework/ComponentManager.class.php

Class Overview

Object
   |
   --ComponentManager

Менеджер набора компонентов документа.


Author(s):

  • dr.Pavka

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

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
final:  


[ Top ]


Class Variables

$components = array()

[line 28]



Tags:

var:   набор компонентов
access:   private

Type:   array


[ Top ]

$document =

[line 34]



Tags:

var:   документ
access:   private

Type:   Document


[ Top ]



Class Methods


constructor __construct [line 43]

void __construct( Document $document)

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



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

Parameters:

Document   $document  

[ Top ]

method addComponent [line 58]

void addComponent( Component $component, [string $fileName = false])

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



Tags:

access:   public


Parameters:

Component   $component  
string   $fileName   имя файла шаблона в котором находится компонент

[ Top ]

method createComponent [line 196]

Component createComponent( string $name, string $module, string $class, [array $params = null])

Создает компонент.



Tags:

access:   public


Parameters:

string   $name  
string   $module  
string   $class  
array   $params  

[ Top ]

method createComponentFromXML [line 143]

Component createComponentFromXML( $componentDescription)

Создание компонента из XML описания



Tags:

access:   public


Parameters:

SimpleXMLElement   $componentDescription   описание компонента

[ Top ]

method getComponentByName [line 72]

Component getComponentByName( string $name)

Возвращает компонент с указанным именем.



Tags:

access:   public


Parameters:

string   $name   имя компонента

[ Top ]

method getComponents [line 214]

array getComponents( )

Возвращает набор компонентов



Tags:

access:   public


[ Top ]

method getComponentsByClassName [line 87]

array getComponentsByClassName( string $className)

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



Tags:

access:   public


Parameters:

string   $className   имя класса

[ Top ]

method loadComponentsFromFile [line 107]

bool loadComponentsFromFile( string $fileName, [string $onlyComponent = false])

Загружает описания компонентов из файла шаблона(layout или content)



Tags:

return:   Возвращает флаг указівающий на то загружены ли компоненты
access:   public


Parameters:

string   $fileName   имя файла content'а или layout'а
string   $onlyComponent   имя компонента который нужно загрузить

[ Top ]

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