SimpRa
Core
[ дерево классов: SimpRa ] [ глоссарий: SimpRa ] [ все элементы ]

Class: Config

Исходники: /core.php

Класс Config

Обзор класса

Осуществляет интерфейсы:

Класс-конфигуратор.

 
 Получает настройки из файлов /app/config/setupdb.ini /app/config/setupsystem.ini.
 Также имеет ряд стандартных настроек путей, имеет возможность добавить или удалить
 переменную в себе. Также может просто вывести их.
 

Находится в: /core.php [line 193]



		
				Автор(ы):
		
		
		
Информационные теги:
Версия:   0.2.2a
Копирайт:   (с) Immortal, 510
Сделать:   Подумать о смысле внесения стандартных настроек путей в setupsystem.ini
Начиная с:   0.1

Свойства

Методы

Все свойства
static object Config   $objConfig   Статичный объект класса. Используется для реализации шаблона "одиночка" (singletone).
array   $system   Массив содержащий основные настройки приложения.

Все методы
static Config   &_Factory()   Фабрика.
Config   __construct()   Собственно конструктор.
array   getBasicSystemConfig()   Генерация основных системных настроек.
array   getDbConfig()   Генерация конфигурации для подключения к базе данных.
void   _Assign()   Функция регистрирует переменную в классе.
void   _Initialize()   Запускает процесс принятия настроек из конфигурационных файлов.
void   _ShowSignedValues()   Функция, выводящая дамп всех переменных, подписанных классом Config
void   _Unsign()   Удаляет переменную.

Свойства
static object Config   $objConfig [line 203]

Статичный объект класса. Используется для реализации шаблона "одиночка" (singletone).

API теги:
Доступ:   public

Информационные теги:
Начиная с:   0.1.0a

array   $system = array() [line 222]

Массив содержащий основные настройки приложения.

 Стандартные настройки:
 $system->root => рут сайта.
 $system->config_dir => директория конфигурационных файлов.
 $system->core_dir => директория, где лежат классы ядра
 $system->mods_dir => директория, где лежат модули.
 $system->mods_dir => директория, где лежат модели.
 $system->service_dir => директория, где лежат шаблоны для страниц ошибок и сервисных страниц.

API теги:
Доступ:   public
Используется:   Router::__construct()
Используется:   Model::__construct()
Используется:   Loader::__construct()
Используется:   Core::__construct()
Используется:   Logger::_Factory()

Информационные теги:
Начиная с:   0.1.0a

Методы
static method _Factory  [line 457]

  static Config &_Factory( )

Фабрика.

Создает один экземпляр класса. Если объект уже существует - вернет его.

Пример использования:

  1.  $Config Config::_Factory();


API теги:
Возвращает:   объект с настройками базы данных
Доступ:   public
Используется:   Logger::_Factory()

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.1
Начиная с:   0.1.0a

Конструктор __construct  [line 238]

  Config __construct( )

Собственно конструктор.

 Один из важнейших конструкторов в приложении. Заполняет массивы настроек.
 Сначала стандартные настройки, затем инициализация процесса получения настроек
 из сторонних файлов.


API теги:
Доступ:   private

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.4
Начиная с:   0.1.0a

getBasicSystemConfig  [line 422]

  array getBasicSystemConfig( )

Генерация основных системных настроек.

 Функция заберет конфигурацию системы из файла setupsystem.php,
 находящегося в /app/config/.
 Если файла нет - создаст исключение.


API теги:
Возвращает:   массив с системными настройками.
Доступ:   private
Используется:   Config::_Initialize() - для создания конфигурации системы

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.4
Начиная с:   0.1.0a

getDbConfig  [line 393]

  array getDbConfig( )

Генерация конфигурации для подключения к базе данных.

 Функция забирает основную конфигурацию для подключения к БД из файла setupdb.php
 находящегося в /app/config/.
 Если такого файла нет - создаст исключение.


API теги:
Возвращает:   массив с настройками базы данных.
Доступ:   private
Используется:   Config::_Initialize() - для создания конфигурации подключения к БД

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.4
Начиная с:   0.1.0a

_Assign  [line 334]

  void _Assign( mixed $name, mixed $value  )

Функция регистрирует переменную в классе.

Не предусматривает защиту от перезаписи.

Пример использования:

  1.  $Config Config::_Factory();
  2.  $Config -> _Assign('some_name''some_value');

Параметры:
mixed   $name: 
mixed   $value: 

API теги:
Доступ:   public
Используется:   Config::_Initialize() - для добавления настроек

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.1
Сделать:   Подумать о защите от перезаписи.
Начиная с:   0.1.0a

Осуществление:
AssignerClass::_Assign()
Функция для добавления свойства, полученного вне класса, но обязанного в нем присутствовать.

_Initialize  [line 292]

  void _Initialize( )

Запускает процесс принятия настроек из конфигурационных файлов.

В случае каких-либо ошибок отлавливает исключения и добавляет критические ошибки.

Пример использования:

  1.  $Config Config::_Factory();
  2.  $Config -> Initialize();


API теги:
Доступ:   public
Использует:   Errors::addCriticalError() - в случае возникновения проблем
Использует:   Config::getDbConfig() - для создания конфигурации подключения к БД
Использует:   Config::_Assign() - для добавления настроек
Использует:   Config::getBasicSystemConfig() - для создания конфигурации системы

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.5
Начиная с:   0.2.0a

_ShowSignedValues  [line 374]

  void _ShowSignedValues( )

Функция, выводящая дамп всех переменных, подписанных классом Config

Пример использования:

  1.  $Config Config::_Factory();
  2.  $Config -> _ShowSignedValues();


API теги:
Доступ:   public

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.1
Начиная с:   0.1.0a

Осуществление:
AssignerClass::_ShowSignedValues()
Функция для вывода всех переменных, подписанных данным класом.

_Unsign  [line 356]

  void _Unsign( string $name  )

Удаляет переменную.

Нет нестандартного обработчики ошибки, если переменная не существует.

Пример использования:

  1.  $Config Config::_Factory();
  2.  $Config -> _Unsign('varible_name');

Параметры:
string   $name: 

API теги:
Доступ:   public

Информационные теги:
Автор:   Denis Ranneft a.k.a. ImmortaL <denis@ranneft.ru>
Версия:   f0.1
Сделать:   Подумать об обработчике ошибки, если такой переменной нет.
Начиная с:   0.1.0a

Осуществление:
AssignerClass::_Unsign()
Функция для удаления свойства класса.


Документация сгенерирована Sat, 04 Dec 2010 16:33:07 +0300 при помощи phpDocumentor 1.4.3