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

Class: ComponentConfig

Source Location: /framework/ComponentConfig.class.php

Class Overview

Object
   |
   --ComponentConfig

Класс реализующий работу с конфигурационным файлом компонента


Author(s):

  • dr.Pavka

Variables

Constants

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 23]
Класс реализующий работу с конфигурационным файлом компонента



Tags:

author:   dr.Pavka
final:  


[ Top ]


Class Variables

$config =  false

[line 41]

Конфигурационный файл



Tags:

access:   private

Type:   SimpleXMLElement


[ Top ]

$currentMethod =  false

[line 49]

Имя текущего метода



Tags:

access:   private

Type:   ConfigElement


[ Top ]



Class Methods


static method uriPatternsCmp [line 210]

static int uriPatternsCmp( string $patternA, string $patternB)

Возвращает флаг, указывающий какой из предложенных паттернов более специфичен Вызывается как callback для uksort



Tags:

access:   private


Parameters:

string   $patternA  
string   $patternB  

[ Top ]

constructor __construct [line 58]

void __construct( string $configFileName, $className, $moduleName)

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



Tags:

access:   public


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

Parameters:

string   $configFileName   имя конфигурационного файла
   $className  
   $moduleName  

[ Top ]

method getActionByURI [line 134]

array getActionByURI( $path)

Возвращает имя действия из конфигурации, основываясь на URI запроса.



Tags:

access:   public


Parameters:

   $path  

[ Top ]

method getConfigPath [line 79]

mixed getConfigPath( string $configFilename, $moduleName)

Возвращает полный путь к конфигурационному файлу, или false если файл не существует.



Tags:

access:   private


Parameters:

string   $configFilename   имя конфигурационного файла
   $moduleName  

[ Top ]

method getCurrentMethodConfig [line 113]

ConfigElement getCurrentMethodConfig( )

Возвращает конфигурацию текущего метода



Tags:

access:   public


[ Top ]

method getMethodConfig [line 188]

SimpleXMLElement getMethodConfig( string $methodName)

Возвращает конфигурацию для указанного метода.



Tags:

access:   public


Parameters:

string   $methodName   имя метода

[ Top ]

method isEmpty [line 124]

boolean isEmpty( )

Возвращает флаг того, что конфиг пустой



Tags:

access:   public


[ Top ]

method setCurrentMethod [line 100]

void setCurrentMethod( string $methodName)

Устанавливает имя текущего метода



Tags:

access:   public


Parameters:

string   $methodName   имя метода

[ Top ]

method sortByKeys [line 232]

array sortByKeys( $data, $callback)

Аналог uksort



Tags:

access:   public


Parameters:

   $data  
   $callback  

[ Top ]


Class Constants

CORE_CONFIG_DIR =  'core/modules/%s/config/'

[line 33]

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

(вместо %s будет подставлено имя модуля, содержащего компонент)



[ Top ]

SITE_CONFIG_DIR =  'site/config/'

[line 27]

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


[ Top ]


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