[API]Краткое описание функций ядра CMS MSC: WebSiteEngine

Кратенькое описание всех функций четвёртого ядра выше названной CMS. (От версии к версии ядро изменялось, здесь идёт описание функций версии 4.0.4, но оно справедливо практически для всех версий четвёртого ядра)

Само ядро можно найти в соответствующих репозиториях обновления CMS (пакет core) и в базовых наборах пакетов, файл index.php класс WSE_ENGINE. Все приведённые функции статические и вызываются соответствующим образом.
Например, для вызова getURL() нужно использовать следующий код:

Код:

WSE_ENGINE::getURL();

Содержание:

1. Работа с URL и URI
2. Работа со скриптами
3. Работа с конфигами
4. Локализации
5. Работа с шаблонами

И так, само описание:

1)Работа с URL и URI

getURL() - возвращает полный url страницы, входных параметров нет.
Пример: http://example.ru/some/intresting/page

getURI() - возвращает массив из элементов, идущих после index.php, входных параметров нет.
Пример: если URL будет такой: http://example.ru/some/intresting/page, в результате функция вернет следующий массив:
[
"some",
"intresting,
"page"
]

getURL_BASE() - возвращает базовый URL сайта, на входе ничего.
Пример: URL страницы: http://example.ru/some/intresting/page, результат работы функции: http://example.ru

getIndex() - возвращает адрес индексной страницы сайта. Работает аналогично getURL_BASE(), но в некоторых случаях возвращает более корректный адрес главной страницы.

2)Работа со скриптами

checkScript($alias) - возвращет данные типа boolen, в зависимости от прохождения начальной проверки скрипта на правильность установки.
Возвращает true при выполнении всех следующих условий:
-В файле script.ini присутствует секция с названием из $alias
-Основной файл скрипта существует и может быть подключен
-Определен класс с названием из $alias.
Если одно из условий не выполняется, то возвращается false.

getScriptInfo($alias) - возвращает содержимое секции $alias из файла scripts.ini в виде ассоциативного массива. (Чаще всего там всего одно поле - 'file')

getAllScriptsInfo() - возвращает содержимое всего файла scripts.ini в виде ассоциативного массива.

3)Работа с конфигами

loadConfig($config) - возвращает содержимое конфигурационного файла $config.

updateConfig($config,$data) - обновляет содержимое конфигурационного файла $config. (Старые данные заменяются данными из $data)

4)Локализации

translate($mark, $script = null, $locale = null) - осуществляет поиск перевода для метки $mark в локализации $script на язык с пометкой $locale

5)Работа с шаблонами

GetContentByTag($tag) - вызывает обработку шаблонного тега content с параметрами из $tag.

RegisterTagHandler($tag_type, $handler) - регистррует обработчик $handler для обработки типа $tag_type тега content.

setTemplate($name) - назначает особый шаблон для страницы.

PrepearHTML($text) - позволяет обработать данные $text как шаблон.

isTmpl($name) - производит проверку наличия файла-шаблона $name.

getTmpl($name) - возвращает "сырой" файл-шаблон.(если файл не существует, то возвращается локализированный текст ошибки TMPL_NOT_FOUND или сам код этой ошибки)

getRTmpl($name, $arr) - возвращает файл-шаблон с замененными переменными.


Если что-то осталось непонятным вы всегда можете поиграться с параметрами и дампом результата, а так же задать вопрос мне.(В этой теме, в ЛС, скайпе и так далее)

Ссылка на тему с CMS.

 

Не так уж и много, всего лишь 17 функций )

 

Начальный этап?

 

Кто то подскажет как самописную CMS но ООП, привести к модулям?