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

Class: Sitemap

Source Location: /framework/Sitemap.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Sitemap

Класс - синглтон Содержит методы по работе со структурой сайта


Author(s):

  • dr.Pavka

Variables

Methods


Inherited Constants

Inherited Variables

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 28]
Класс - синглтон Содержит методы по работе со структурой сайта



Tags:

author:   dr.Pavka
todo:   проблема с конечными страницами
final:  


[ Top ]


Class Variables

static $instance =

[line 40]



Tags:

var:   Instance объекта Sitema
access:   private

Type:   Sitemap


[ Top ]

$allInfo = array()

[line 55]

Информация обо всех разделах(включая те на которые у текущего юзера нет прав)



Tags:

access:   private

Type:   array


[ Top ]

$cacheAccessLevels = array()

[line 99]

Кеширование уровней доступа



Tags:

access:   private

Type:   array


[ Top ]

$defaultID =  false

[line 64]

Идентификатор дефолтной страницы Вынесено в переменную чтоб не дергать запрос постоянно



Tags:

access:   private

Type:   int


[ Top ]

$defaultMetaDescription =

[line 83]

Дефолтное meta description



Tags:

see:   Sitemap::defaultMetaKeywords
access:   private

Type:   string


[ Top ]

$defaultMetaKeywords =

[line 74]

Дефолтные meta keywords Используется для всех страниц у которых не указано Вынесено в отдельную переменную, чтобы не дергать каждый раз запрос



Tags:

access:   private

Type:   string


[ Top ]

$info = array()

[line 47]

Информация о тех разделах, на которіе у юзера есть права



Tags:

access:   private

Type:   array


[ Top ]

$langID =

[line 91]

Идентификатор текущего языка



Tags:

access:   private

Type:   int


[ Top ]

$tree =

[line 33]



Tags:

var:   Экземпляр класса реализующего работу с древовидными структурами
access:   private

Type:   TreeNodeList


[ Top ]



Class Methods


static method getInstance [line 162]

static Sitemap getInstance( )

Возвращает экземпляр объекта Sitemap



Tags:

access:   public


[ Top ]

constructor __construct [line 107]

void __construct( )

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



Tags:

access:   public


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

[ Top ]

method buildPagesMap [line 402]

array buildPagesMap( array $ids)

По переданному массиву идентификаторов разделов и массиву перечня полей формирует cтруктуру array('$идентификатор_раздела'=>array())



Tags:

access:   private


Parameters:

array   $ids   идентификаторы разделов

[ Top ]

method checkPageRights [line 466]

boolean checkPageRights( array $smapInfo)

Внутренний метод для фильтрации разделов, на которые нет прав Вызывется как callback для array_filter



Tags:

access:   private


Parameters:

array   $smapInfo  

[ Top ]

method getChilds [line 352]

array getChilds( int $smapID)

Возвращает все дочерние разделы



Tags:

access:   public


Parameters:

int   $smapID   идентификатор раздела

[ Top ]

method getDefault [line 232]

int getDefault( )

Возвращает идентификатор страницы по умолчанию



Tags:

access:   public


[ Top ]

method getDocumentInfo [line 424]

array getDocumentInfo( int $id)

Возвращает информацию о документе Ищем документ с нужным идентификатором в $this->info



Tags:

access:   public


Parameters:

int   $id   Идентификатор раздела

[ Top ]

method getDocumentRights [line 319]

int getDocumentRights( int $docID, [mixed $groups = false])

Определение прав набора групп на страницу



Tags:

access:   public


Parameters:

int   $docID   идентификатор документа
mixed   $groups   группа/набор групп, если не указан, берется группа/группы текущего пользовател

[ Top ]

method getIDByURI [line 285]

int getIDByURI( $segments, [ $useDefaultIfEmpty = false])

Возвращает идентификатор страницы по его URL



Tags:

access:   public


Parameters:

array   $segments  
   $useDefaultIfEmpty  

[ Top ]

method getInfo [line 453]

array getInfo( )

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



Tags:

access:   public


[ Top ]

method getMainLevel [line 339]

array getMainLevel( )

Возвращает меню первого уровн



Tags:

access:   public


[ Top ]

method getParent [line 367]

int getParent( $smapID)

Возвращает родителя



Tags:

access:   public


Parameters:

   $smapID  

[ Top ]

method getParents [line 385]

array getParents( int $smapID)

Возвращает массив родителей



Tags:

access:   public


Parameters:

int   $smapID   Идентфикатор раздела

[ Top ]

method getSitemapData [line 177]

array getSitemapData( mixed $id)

Метод возвращающий информацию о разделах



Tags:

access:   private


Parameters:

mixed   $id   идентификатор раздела или массив идентификаторов

[ Top ]

method getTree [line 442]

TreeNodeList getTree( )

Возвращает объект Tree



Tags:

access:   public


[ Top ]

method getURLByID [line 254]

string getURLByID( int $smapID)

Возвращает часть строки УРЛ по идентификатор



Tags:

todo:   Ошибка с вычислением URL для конечных разделов
access:   public


Parameters:

int   $smapID  

[ Top ]

method preparePageInfo [line 215]

array preparePageInfo( array $current)

Внутренний метод по преобразования информации о документе. Сводит все ключи к camel notation и для линка изменяет значение идентификатора шаблона



Tags:

access:   private


Parameters:

array   $current  

[ Top ]

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