API MaxSite CMS¶

• Table of contents
• API MaxSite CMS
  • Функции основные
  • Функции для работы с записями(страницами)
  • Функции для работы с категориями(рубриками)
  • Функции для работы с комментариями
  • Функции для редактирования, удаления, добавления
  • Функции для meta-полей (пользовательские поля), включая теги(метки)
  • Функции для работы с ini-файлами
  • Функции для загрузки файлов, создания миниатюры и описания файла
  • Функции замены mbstring
  • Функции в административном разделе
  • Функции для работы с шаблоном

Функции основные¶

источник: \application\maxsite\common\common.php

1. getinfo - получает нужного значения
2. pr - функция для отладки
3. _pr - аналогичная pr, только завершается die(), используется для отладки с помощью прерывания
4. _sql - формирует sql-запрос, используется для отладки перед $CI->db->get()
5. mso_valid_email - проверяет email на корректность
6. mso_checkreferer - проверяет рефер на xss-атаку, работает только если есть POST
7. mso_checksession - защитает сессию, сравнивает переданную сессию с текущей
8. mso_strip - удаляет все лишнее в формах
9. mso_initalizing - функция инициализации
   • _mso_require_functions_file - подключает файл functions.php в шаблоне, если есть, функциця срабатывает по хуку init
10. is_login - проверяет залогиненность пользователя (юзер)
11. is_login_comuser - проверяет залогиненность комюзера
12. mso_autoload_plugins - загружает включенные плагины
13. is_type - проверяет тип записи(страницы), который определился в контролере
14. is_type_slug - возвращает true или false при проверке $MSO->data['uri_segment'], то есть по сегментам URL
15. is_page_cat - проверяет рубрику записи(страницы)
16. is_feed - проверяет, если feed
17. mso_head_meta - выводит html meta (title, description, keywords) записи(страницы), есть хук hook head_meta
18. mso_plugin_load - подключает плагин
19. mso_admin_plugin_load - подключает admin-плагин , выполняется только при входе в админку
20. mso_hook_add - подключает функцию к хуку, приоритет по-умолчанию 10.
21. mso_admin_url_hook - прописывает хук к admin_url_+hook
22. mso_hook - выполняет хук
23. mso_hook_present - проверяет существование хука
24. mso_remove_hook - удаляет из хука функцию
25. mso_hook_add_dinamic - динамически создает функции на хук
26. mso_md5 - генерирует md5
27. mso_refresh_options - сбрасывает кэш опций
28. mso_add_option - добавляет в таблицу опций options
29. mso_delete_option - удаляет в таблице опций options ключа с типом
30. mso_delete_option_mask - удаляет в таблице опций options ключа-маски с типом
31. mso_get_option - получает опции из кэша опций
32. mso_add_float_option - добавляет float-опции (файл из серилизованного текста в каталоге uploads)
33. mso_get_float_option - получает данные из flat-опций
34. mso_delete_float_option - удаляет flat-опции, если есть
35. mso_add_cache - добавляет кэш (ключ, значение, время), есть хук hook mso_add_cache
36. mso_flush_cache_mask - удаляет файл в кэше файлов, начинающихся с указанной строки, есть хук hook mso_flush_cache_mask
37. mso_flush_cache] - сбрасывает кэш , есть хук hook mso_flush_cache
38. mso_get_cache - получает кеш по ключу, есть хук hook mso_get_cache
39. mso_text_to_html - преобразовывает html-спецсимволы в тексте в обычный html, есть хук hook text_to_html
40. mso_html_to_text - преобразовывает html-спецсимволы, есть хук hook html_to_text
41. mso_clean_pre_special_chars - удалеет PRE + mso_auto_tag
42. mso_clean_pre - удаляет PRE + mso_auto_tag
43. mso_clean_pre_do - pre, которое вставляется в [html_base64]
44. mso_clean_block - удаляет блоковых тэгов, удаляем в них <p>
45. mso_clean_block2 - аналогично, только еще и [] меняет
46. mso_clean_html - преобразовывает введенный html в тексте между [html] ... [/html] и для [volkman] к обычному html
47. mso_clean_html_do - преподготовка html в тексте между [html] ... [/html], конвертирует все символы в реальный html, после этого кодирует его в одну строчку base64, после всех операций в mso_balance_tags декодирует его в обычный текст mso_clean_html_posle. Кодирование нужно для того, чтобы корректно пропустить весь остальной текст.
48. mso_clean_html_posle - декодирует из mso_balance_tags см. mso_clean_html_do
49. mso_auto_tag - авторасстановка тэгов, есть хуки hook content_auto_tag_custom], [[hook content_auto_tag_do, hook content_auto_tag_my
50. mso_balance_tags - функция авторасстановки тэгов, есть хуки hook content_balance_tags_custom, hook content_balance_tags_my
51. mso_slug - преобразовывает русские, украинские буквы в английские, также удаляет все служебные символы, есть хуки hook slug_do, hook slug, hook slug_posle
52. mso_redirect - редиректит на страницу сайта, путь указывается относительно сайта
53. mso_current_url - получает текущего url относительно сайта
54. mso_form_session - формирует скрытый input для формы с текущей сессией
55. mso_login_form - выводит форму логина, есть хук hook login_form_auth
56. mso_nocache_headers - посылает в хидере no-кэш
57. mso_check_post - проверяет существование POST, а также обязательных полей
58. mso_array_get_key - получает из массива номера $num_key ключа
59. mso_array_get_key - получает из массива номера $num_key ключа
60. mso_array_get_key_value - получает из массива ключ значения
61. mso_check_user_password - проверяет комбинации логина-пароля
62. mso_get_user_data - получает данные юзера по его логину/паролю
63. mso_create_allow - создает разрешения для действия
64. mso_remove_allow - удаляет действие/функцию
65. mso_check_allow - проверяет доступ юзера для указанного действия/функции
66. [[mso_segment] - получает название указанного сегмента текущей страницы
67. mso_date_convert - преобразовывает MySql-даты (ГГГГ-ММ-ДД ЧЧ:ММ:СС) в указанный формат date
68. mso_date_convert_to_mysql - переобразовывает даты в формат MySql
69. mso_get_permalink_page - получает пермалинк страницы по ее id через запрос БД
70. mso_get_permalink_cat_slug - получает пермалинк рубрики по указанному слагу
71. mso_explode - разделяет строку из чисел, разделенных запятыми в массив
72. mso_str_word - обрезает строку на количество слов
73. mso_wordcount - подсчитывает количество слов в тексте
74. mso_current_paged - получает текущую страницу пагинации
75. mso_url_paged_inc - увеличевает или уменьшает ссылки next на указанную величину $inc
76. mso_register_sidebar - регистрирует сайдбар
77. mso_register_widget - регистрирует виджет
78. mso_show_sidebar - выводит сайдбар(sidebar)
79. mso_widget_get_post - вспомогательная функция, которая принимает глобальный _POST
80. mso_mail - отправляет письма по email, есть хуки hook mail, hook mail_res
81. mso_wordwrap - для юникода отдельный wordwrap
82. mso_load_jquery - возвращает script с jquery или +url
83. mso_menu_build - формирует li-элементы для меню
84. mso_add_to_cookie - добавляет куку ко всему сайту с помощью сессии и редиректа на главную или другую указанную страницу (после главной)
85. mso_get_cookie - получает куку, если нет вообще или нет в $allow_vals, то возвращает $def_value
86. mso_create_list - строит из массивов спискок UL
87. mso_cur_dir_lang - устанавливает $MSO->current_lang_dir, в которой хранится текущий каталог языка, второй параметр функции t()
88. tf - функция для языкового перевода MaxSite CMS, описание см. ниже для _t()
89. t - функция для языкового перевода, только для админки
    • _t - вспомогательная функция языкового перевода (не использовать напрямую) , используется в функциях t и tf
    • _t_add_file_to_lang вспомогательная функция для _t (не использовать напрямую)
90. mso_get_author_info - получает информацию об авторе по его номеру
91. mso_segment_array - получает текущие сегменты url в массив
92. mso_url_get - получает get-строки из текущего адреса
93. mso_parse_url_get - преобразует get-строки в массив
94. mso_page_foreach - выводит кастомный цикл, есть хуки hook type-foreach-file-general, hook type-foreach-file
95. _mso_login - функция залогирования
96. _mso_logout - функция разлогирования
97. mso_xss_clean - проверяет на XSS-атаку входящий текст
98. mso_xss_clean_data - преобразовывает ключи входящего массив данных через xss_clean
99. mso_clean_str - преобразовывает строку $str через фильтры, согласно указанным в $rules правилам
100. mso_clean_post - возвращает массив $post обработанный по указанным правилам
101. mso_sql_found_rows - возвращает массив для пагинации при выполнении предыдущего sql-запроса с SELECT SQL_CALC_FOUND_ROWS
102. mso_rss - формирует rss в <link rel...>
103. mso_get_val - использует глобальный одномерный массив, который используется для получения значения указанного ключа $key
104. mso_set_val - обратная mso_get_val() - задаёт для ключа $key значение $val
105. mso_unset_val - удаляет ключ $key
106. mso_link_rel - формирует <link rel="$REL" $ADD>
107. mso_widget_create_form - функция для виджетов, формирует поля формы для form.fform с необходимой html-разметкой
108. mso_lessc - компилирует LESS в CSS
     • _mso_less_import_all - служебная функция для less, возвращает строки с @import url(less-файл)
     • _mso_less_import_all_dir - служебная функция для less, возвращает строки с @import url(less-файл)
109. mso_load_style - формирует <style> из указанного адреса
110. mso_load_script - формирует <script> из указанного адреса
111. mso_dispatcher - возвращает полный путь к файлу, который следует подключить в index.php шаблона, использовать вместо старого варианта выбора type-файла, есть хук hook custom_page_404
112. mso_find_ts_file - ищет файл либо в каталоге шаблона, либо в shared-каталоге
113. mso_get_path_files - возвращает массив $path_url-файлов по указанному $path - каталог на сервере
114. mso_get_dirs - возвращает подкаталоги в указаном каталоге
115. mso_fe - возвращает полный путь к файлу
116. mso_section_to_array - преобразовывает входящещий текст опции в массив
     • _mso_section_to_array_replace_start - callback-функция для mso_section_to_array
117. _mso_section_to_array_replace_end - callback-функция для mso_section_to_array, обратная функция преобразования [base64] в html
118. _mso_profiler_start - иницирует начало профилирования
119. _mso_profiler_end - инициирует окончание профилирования

Функции для работы с записями(страницами)¶

источник: \application\maxsite\common\page.php

1. mso_get_pages - получает выборку записей(страниц), есть хуки hook mso_get_pages, hook content_init, hook content_in, hook content, hook content_auto_tag, hook content_balance_tags, hook content_out, hook content_complete,
   • _mso_sql_build_home - главная страница - home
   • _mso_sql_build_page - одиночная страница по id или slug
   • _mso_sql_build_category - рубрики
   • _mso_sql_build_tag - страница меток
   • _mso_sql_build_archive - архивы по датам
   • _mso_sql_build_search - страница поиска
   • _mso_sql_build_author - страницы автора
2. mso_page_edit_link - получает ссылку на редактирование страницы
3. mso_page_cat_link - получает ссылки на рубрики указанной страницы
4. mso_page_tag_link - получает ссылки на метки указанной страницы
5. mso_page_date - получает дату записи(страницы)
6. mso_page_url - формирует http-адрес страницы по slug и type
7. mso_page_title - формирует заголовок или ссылку на запись(страницу)
8. mso_page_feed - формирует ссылки для rss записи(страницы)
9. mso_page_content - выводит текст записи(страницы), есть хуки hook content_start, hook content_content,
10. mso_page_content_end - для некоторых плагинов нужно выводить после всех хуков на content, есть хук hook content_end
11. mso_page_meta - получает мета-поле (пользовательское поле) записи(страницы)
12. mso_page_meta_value - получает значение meta-поля (пользовательское поле), если нет, то отдается $default
13. mso_page_comments_link - формирует ссылку «обсудить», если разрешено комментирование записи(статьи)
14. mso_page_author_link - получает ссылки на автора страницы
15. get_total_days - функция из Calendar.php
16. mso_page_view_count_first - проверяет из куки значение массива с текущим url
17. mso_page_view_count - выводит количество просмотров текущей записи
18. mso_page_nav - выводит список записей(страниц) по паренту - навигация под страницами - все связанные
19. mso_page_map - выводит карту записей(страниц) по паренту - готовый массив с вложениями с childs=>...
20. _mso_page_map_get_child - вспомогательная рекурсивная функция для получения всех потомков страницы
21. mso_page_other_pages - выводит блок "Еще записи этой рубрики"
22. mso_next_prev_page - получает следующую и предыдущую запись после указанной
    • _sql_next_page - вспомогательная функция для next mso_next_prev_page
    • _sql_prev_page - вспомогательная функция для prev mso_next_prev_page

Функции для работы с категориями(рубриками)¶

источник: \application\maxsite\common\category.php

1. mso_get_cat_page - получает номера рубрик указанной страницы в виде массива
2. mso_get_page_cat - получает номера записей указанной рубрики в виде массива
3. mso_cat - получает ul-списка всех рубрик путем sql-запроса
   • _get_child2 - вспомогательная функция для создания списка mso_cat
4. mso_cat_array - получает все рубрики в массиве - сразу всё с учетом вложенности
   • _get_child - вспомогательная рекурсивная функция для получения всех потомков рубрики mso_cat_array
5. mso_cat_array_single - получает все рубрики в одномерной структуре
6. mso_cat_ul - получает ul-списка всех рубрик
   • _mso_cat_ul_glue - рекурсивная вспомогательная функция к mso_cat_ul
7. mso_get_cat_from_slug - получает ID категории по slug (короткая ссылка)
8. mso_get_cat_url_from_id - получает url рубрики по ID
9. mso_get_cat_from_id - получает произвольный ключ рубрики ID
10. mso_get_cat_key - получает по указанному $slug (короткая ссылка) значение ключа рубрики

Функции для работы с комментариями¶

источник: \application\maxsite\common\comments.php

1. mso_get_comments - получает комментарии, есть хуки hook mso_get_comments_args, hook comments_content, hook comments_content_custom, hook content_balance_tags, hook comments_content_out
2. mso_email_message_new_comment - отправляет админу уведомление о новом комментарии, есть хук hook mso_email_message_new_comment
3. mso_email_message_new_comuser - отправляет новому комюзеру уведомление о новой регистрации
4. mso_get_new_comment - добавляет новый комментарий и выводит сообщение о результате, есть хуки hook mso_get_new_comment_args, hook add_new_comment, hook comments_new_captcha, hook comments_new_captcha_error, hook new_comments_content, hook new_comments_check_spam, hook new_comment, hook new_comments_check_spam_comusers
5. mso_get_comuser - получает данные комюзера, есть хуки hook comments_content, hook comments_content_custom, hook content_balance_tags, hook comments_content_out
6. mso_comuser_set_count_comment - устанавливает количество комментариев у указанного комюзера
7. mso_comuser_update_count_comment - проверяет в цикле количество реальных комментариев
8. mso_comuser_edit - обрабатывает POST из формы комюзера
9. mso_comuser_lost - восстанавливает пароль комюзера
10. mso_get_comusers_all - выводит список всех комюзеров
11. mso_comments_content - ???
12. mso_email_message_new_comment_subscribe - рассылает по email уведомление о новом комментарии
13. mso_comuser_auth - авторизовывает/регистрирует комюзера
14. mso_last_activity_comment - определяет времени последнего комментария и сравнивает с текущим
15. mso_avatar - выводит аватарку комментатора

Функции для редактирования, удаления, добавления¶

источник: \application\maxsite\common\functions-edit.php

1. mso_edit_category - редактирует категорию(рубрику), есть хук hook edit_category
2. mso_new_category - добавляет новую категорию, есть хук hook new_category
3. mso_delete_category - удаляет категорию, есть хук hook delete_category
4. mso_edit_user - редактирует пользователя(user)
5. mso_new_user - создает нового пользователя(user)
6. mso_delete_user - удаляет пользователя(user)
7. mso_new_page - создает новую запись(страницу), есть хуки hook new_page, hook new_page_
8. mso_edit_page - редактирует существующую запись(страницу), есть хуки hook edit_page, hook edit_page_
9. mso_delete_page - удаляет запись(страницу)
10. mso_edit_comuser - редактирует существующего комюзера(comuser)

Функции для meta-полей (пользовательские поля), включая теги(метки)¶

источник: \application\maxsite\common\meta.php

1. mso_get_tags_page - получает все метки указанной записи(страницы)
2. mso_get_all_tags_page - получает все метки в массиве
3. mso_get_meta - получает данные из таблицы 'meta'
4. mso_add_meta - записывает данные в таблицу 'meta'

Функции для работы с ini-файлами¶

источник: \application\maxsite\common\inifile.php

1. parse_ini_string - если PHP < 5.3 (c) http://www.php.net/manual/ru/function.parse-ini-string.php
2. mso_get_ini_file - загружает ini-файл
3. mso_check_post_ini - проверяет есть ли POST
4. mso_view_ini - выводит ini-поля в виде таблицы
   • _mso_ini_check_php - проверяет вхождение PHP_START функция PHP_END
   • _mso_ini_check_php_callback - вспомогательная функция
5. mso_parse_ini_values - преобразовывает values в массив ключ => описание, заданного в ini-файле в виде ключ || описание
6. mso_find_options_key - возвращает массив заданный в ini-файле в options_key, заменяет название элемента массива с названия на options_key , при этом добавляет поле options_name, равное названию опции

Функции для загрузки файлов, создания миниатюры и описания файла¶

источник: \application\maxsite\common\uploads.php

1. mso_prepare_files - преобразует $_FILES в массив для mso_upload
2. mso_upload - загружает, изменяет размеры, создает миниатюры, описания и т.д.
3. mso_upload_mini - создает миниатюры
4. mso_upload_prev - создает превью 100x100

Функции замены mbstring¶

источник: \application\maxsite\common\mbstring.php

1. mb_strlen
2. mb_substr
3. mb_strwidth
4. mb_strtolower
5. mb_strtoupper
6. mb_convert_encoding
7. mb_stristr
8. mb_strpos
9. mb_stripos

Функции в административном разделе¶

источник: \application\maxsite\admin\common.php

1. mso_admin_init - инициализация админки, есть хуки hook admin_menu, hook admin_menu_default, hook admin_init
2. mso_admin_menu_add - добавляет пункт меню админки
3. _mso_del_menu_pod - служебная функция, удаляет из меню начальные цифры 10_меню -> меню
4. mso_admin_menu - выводит меню в шаблоне админки, есть хуки hook admin_menu, hook admin_menu_default
5. mso_admin_header - выводит хидера в шаблоне админки, есть хуки hook admin_header, hook admin_header_default
6. mso_admin_footer - выводит футера в шаблоне админки, есть хуки hook admin_footer, hook admin_footer_default
7. mso_admin_content - выводит контента в шаблоне админки, есть хуки hook admin_content_do, hook admin_content_default, hook admin_content
8. mso_admin_link_segment_build - строит ссылки с учетом указанного 3-го сегмента
9. mso_plugin_deactivate - выполняет действия при деактивация плагина
10. mso_plugin_activate - выполняет действия при активация плагина
11. mso_plugin_uninstall - выполняет действия при удалении плагина

источник : \application\maxsite\admin\default.php

1. mso_admin_menu_default - подключает меню по-умолчанию
2. mso_admin_header_default - функция не используется
3. mso_admin_content_default - выводит контент админки по-умолчанию
4. mso_admin_footer_default - выводит футер админки по-умолчанию

Функции для работы с шаблоном¶

источник: \application\maxsite\shared\functions\template.php

1. default_favicon - возвращает файлы для favicon
2. default_components - возвращает файлы для компонент
3. default_profiles - возвращает файлы для css-профиля
4. default_header_logo - возвращает файлы для логотипа
5. default_header_image - возвращает каталоги в uploads, где могут храниться файлы для шапки
6. default_out_profiles - выводит подключенные css-профилей
7. get_component_fn - возвращает полный путь к файлу компонента для указанной опции
8. out_component_css - подключает файлы css-style установленных компонентов и выводит их содержимое в едином блоке <style>
9. mso_default_head_section - типовой вывод секции HEAD, есть хуки hook head-start, hook head, hook head-end
10. mso_out_css_file - получает css из указанного файла, в css-файле можно использовать php, осуществляется сжатие css
11. mso_add_file - формирует <script> с внешним js-файлом или формирование <link rel="stylesheet> с внешним css-файлом