Class: Document

Source Location: /framework/Document.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Document

Документ страницы.

Author(s):

dr.Pavka

Variables

Constants

Methods

Inherited Constants

Class: Object

Object::CONFIG_DIR
Object::CONFIG_FILE

Inherited Variables

Class: DBWorker

DBWorker::$dbh
DBWorker::$dbhInstance

Class: Object

Object::$executionTime
Object::$systemConfig
Object::$values

Inherited Methods

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 21]
Документ страницы.

Tags:

author:	dr.Pavka
final:

[ Top ]

Class Variables

$componentManager =

[line 66]

Tags:

var:	менеджер компонентов
access:	public

Type:

ComponentManager

[ Top ]

$contentComponents = array()

[line 114]

Перечень компонентов content'а

Tags:

access:

private

Type:

array

[ Top ]

$doc =

[line 72]

Tags:

var:	результирующий DOM-документ
access:	private

Type:

DOMDocument

[ Top ]

$documentInfo = array()

[line 98]

Tags:

var:	информация о документе
see:	Sitemap::getDocumentInfo()
access:	private

Type:

array

[ Top ]

$id = false

[line 36]

Tags:

var:	идентификатор документа
access:	private

Type:

int

[ Top ]

$lang =

[line 42]

Tags:

var:	идентификатор языка документа
access:	private

Type:

int

[ Top ]

$language =

[line 48]

Tags:

var:	информация о языках системы
access:	protected

Type:

Language

[ Top ]

$layoutComponents = array()

[line 106]

Перечень компонентов layout'а

Tags:

access:

private

Type:

array

[ Top ]

$properties = array()

[line 84]

Tags:

var:	свойства документа
access:	private

Type:

array

[ Top ]

$request =

[line 60]

Tags:

access:

private

Type:

Request

[ Top ]

$rights = false

[line 78]

Tags:

var:	права пользователя на документ
access:	private

Type:

int

[ Top ]

$sitemap =

[line 54]

Tags:

var:	карта сайта
access:	protected

Type:

Sitemap

[ Top ]

$translations = array()

[line 122]

Массив констант для перевода

Tags:

access:

private

Type:	array
Overrides:	Array

[ Top ]

$user =

[line 91]

Tags:

var:	экземпляр класса AuthUser
see:	AuthUser
access:	public

Type:

AuthUser

[ Top ]

Class Methods

constructor __construct [line 130]

void __construct(

$segments)

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

Tags:

access:

public

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

Parameters:

$segments

[ Top ]

method addTranslation [line 463]

void addTranslation(
string
$const, [Component
$component = null])

Добавляет константу перевода к документу

Tags:

access:

public

Parameters:

string	$const
Component	$component

[ Top ]

method build [line 205]

DOMDocument build(
)

Запускает построение компонентов страницы и возвращает результат в виде собранного DOM-документа страницы.

Tags:

access:

public

[ Top ]

method getID [line 184]

int getID(
)

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

Tags:

access:

public

[ Top ]

method getLang [line 194]

int getLang(
)

Возвращает идентификатор языка документа.

Tags:

access:

public

[ Top ]

method getProperty [line 422]

string getProperty(
string
$propName)

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

Tags:

access:

public

Parameters:

string

$propName

[ Top ]

method getResult [line 379]

DOMDocument getResult(
)

Возвращает результирующий DOM-документ.

Tags:

access:

public

[ Top ]

method getRights [line 399]

int getRights(
)

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

Tags:

access:

public

[ Top ]

method getUser [line 389]

AuthUser getUser(
)

Возвращает объект текущего пользователя.

Tags:

access:

public

[ Top ]

method isEditable [line 467]

void isEditable(
)

Tags:

access:

public

[ Top ]

method loadComponents [line 304]

void loadComponents(
int
$templateID)

Определяет компоненты страницы и загружает их в менеджер компонентов.

Tags:

todo:	Полный рефакторинг!
access:	public

Parameters:

int

$templateID

идентификатор шаблона страницы

[ Top ]

method removeProperty [line 436]

void removeProperty(
string
$propName)

Удаляет свойство документа.

Tags:

access:

protected

Parameters:

string

$propName

[ Top ]

method runComponents [line 357]

void runComponents(
)

Запускает работу всех компонентов страницы.

Tags:

access:

public

[ Top ]

method setProperty [line 411]

void setProperty(
string
$propName, string
$propValue)

Устанавливает значение свойства документа.

Tags:

access:

public

Parameters:

string	$propName
string	$propValue

[ Top ]

Class Constants

SINGLE_SEGMENT = 'single'

[line 25]

Зарезервированный сегмент URL для single-режима

[ Top ]

TEMPLATES_DIR = 'templates/'

[line 30]

Путь к директории с конфигурационными шаблонами

[ Top ]

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