Файл metodadapter.php содержит набор функций, необходимых пользователям
для построения собственных скриптов.
Все функции этого файла являются алиасами для аналогичных функций из класса MG.
Целью использования данного файла является исключение из пользовательских
файлов сложного для понимания синтаксиса MG::
void | mgAddAction() |
Метод addAction Добавляет обработчик для заданного хука.
mgAddAction('printHeader', 'userfunc', 2);
|
void | mgAddActionOnce() |
Добавляет обработчик для заданного хука, если такой обработчик еще не был добавлен.
mgAddActionOnce('printHeader', 'userfunc', 2);
|
void | mgAddCustomPriceAction() |
Метод mgAddCustomPriceAction Добавляет обработчик для изменения цены товара, до того как он попал в корзину.
mgAddCustomPriceAction(array(__CLASS__, 'applyRate'));
|
void | mgAddShortcode() |
Метод addAction Добавляет обработчик шорткода.
mgAddShortcode('buy-click', array(__CLASS__, 'buyOneClick'));
|
void | mgPageThisPlugin() |
Добавляет обработчик для страницы плагина. Назначенная в качестве обработчика пользовательская функция будет, отрисовывать страницу настроек плагина.
mgPageThisPlugin(__FILE__, array(__CLASS__, 'pageSettingsPlugin'));
|
void | mgActivateThisPlugin() |
Добавляет обработчик для активации плагина, пользовательская функция будет срабатывать тогда когда в панели администрирования будет активирован плагин. Является необязательным атрибутом плагина, при отсутствии этого обработчика плагин тоже будет работать. Функция обрабатывающая событие не должна производить вывод (echo, print, print_r, var_dump), это нарушит логику работы AJAX.
mgActivateThisPlugin(__FILE__, array(__CLASS__, 'activate'));
|
void | mgDeactivateThisPlugin() |
Добавляет обработчик для дезактивации плагина, пользовательская функция будет срабатывать тогда когда в панели администрирования будет выключен плагин. Является необязательным атрибутом плагина, при отсутствии этого обработчика плагин тоже будет работать. Функция обрабатывающая событие не должна производить вывод (echo, print, print_r, var_dump), это нарушит логику работы AJAX.
mgDeactivateThisPlugin(__FILE__, array(__CLASS__, 'deActivate'));
|
void | mgCreateHook() |
Создает hook - крючок, для пользовательских функций и плагинов.
mgCreateHook('hook');
|
bool|void | mgAddMeta() |
Добавляет в секцию подключение JS и CSS файлов в публичной части сайта.
mgAddMeta('<link href="'.SITE.'/mg-plugins/news/css/style.css" rel="stylesheet" type="text/css">'); |
void | mgExcludeMeta() |
Исключает из реестра mgAddMeta , указанный статичный файл
mgExcludeMeta('<link href="mg-plugins/news/css/style.css" rel="stylesheet" type="text/css">');
|
void | setOption() |
Устанавливает значение для опции (настройки).
$data = array( |
string|array | getOption() |
Возвращает значение для запрошенной опции (настройки). Имеет два режима: 1. getOption('optionName') - вернет только значение; 2. getOption('optionName', true) - вернет всю информацию об опции в виде массива.
echo getOption('sitename'); // 'moguta.ru'
$res = getOption('sitename', true); |
string | mgMenu() |
Получить меню в HTML виде. Ставится в месте вывода меню.
mgMenu();
|
string | mgMenuFull() |
Получить полное меню в HTML виде. Ставится в месте вывода меню. |
array | mgGetCart() |
Получить товары из корзины.
$res = mgGetCart(); |
bool | mgMeta() |
Возвращает шорткод для подготовленных мета данных (seo, ссылки на css и js файлы).
<head> |
string | mgMetaInsertMode() |
Выводит подготовленные мета данные (seo, ссылки на css и js файлы). @ignore |
string | mgMetaInsert() |
Выводит все подготовленные мета данные (seo, ссылки на css и js файлы). @ignore |
@ignore | removePropCode() | Удаляет шорткод характеристики |
void | mgSEO() |
Устанавливает SEO данные страницы: title, description, keywords.
$data = array( |
void | mgTitle() |
Задает заголовок страницы.
mgTitle('Заголовок');
|
void | viewData() |
Выводит содержимое массива на страницу
$data = array(1, 2, 5, 'data'); |
string | mgDeclensionNum() |
Склонение числительных.
$data['searchData']['count'] = 5; |
bool | isStaticPage() |
Проверяет является ли страница статичной, созданной из панели администрирования
$res = isStaticPage(); |
void | mgSmallCartBlock() |
Выводит блок стандартной маленькой корзины в HTML виде. Использует 'layout_cart' текущего шаблона.
mgSmallCartBlock($data);
|
void | mgSearchBlock() |
Выводит блок стандартного поиска в HTML виде. Использует 'layout_search' текущего шаблона.
mgSearchBlock();
|
void | mgContactBlock() |
Выводит блок с контактами в HTML виде. Использует 'layout_cart' текущего шаблона.
mgContactBlock();
|
string | mgImageProduct() |
Возвращает правильно сформированную картинку для продукта в HTML. Со всеми параметрами, для эффекта перелета в корзину.
echo mgImageProduct($data['item'],false,'MID',true);
|
string | mgImageProductPath() |
Функция возвращает сформированную ссылку на картинку
$res = mgImageProductPath($value["image_url"], $value['id'], 'small'); |
void | mgSubCategory() |
Возвращает список вложенных категорий в HTML виде. Использует 'layout_subcategory' текущего шаблона.
mgSubCategory(5);
|
void | mgGalleryProduct() |
Возвращает правильно верстку картинок товара в HTML. Использует 'layout_images' текущего шаблона.
mgGalleryProduct($data);
|
string | mgLogo() |
Возвращает картинку логотипа магазина, установленную в настройках.
echo mgLogo();
|
bool | layout() |
Выводит верстку содержащуюся в заданном layout.
layout('cart', $data);
|
void | priceFormat() |
Возвращает цену в отформатированном виде. @ignore |
void | filterCatalog() |
Возвращает html код фильтров магазина. Работает только для разделов каталога.
filterCatalog();
|
void | copyrightMoguta() |
Возвращает html код копирайта Moguta.CMS в футере сайта
copyrightMoguta();
|
void | backgroundSite() |
Добавляет фоновое изображение, если выбрано в настройках
<body backgroundSite(); >
|
bool | isIndex() |
Возвращает true, если открыта главная страница
$result = isIndex(); |
bool | isCatalog() |
Возвращает true, если открыта страница каталога
$result = isCatalog(); |
bool | isCart() |
Возвращает true, если открыта страница корзины
$result = isCart(); |
bool | isOrder() |
Возвращает true, если открыта страница заказа
$result = isOrder(); |
bool | isSearch() |
Возвращает true, если открыта страница поиска
$result = isSearch(); |
string|bool | horizontMenu() |
Возвращает верстку горизонтального меню, если оно подключено в настройках Использует 'layout_horizontmenu' текущего шаблона.
echo horizontMenu();
|
bool | horizontMenuDisable() |
Возвращает false, если горизонтальное меню подключено в настройках
$result = horizontMenuDisable(); |
bool | catalogToIndex() |
Возвращает значение флага, для опции вывода каталога на главной
$result = catalogToIndex(); |
string | mgGetPaymentRateTitle() |
Возвращает приписку с наценкой для способа оплаты
echo mgGetPaymentRateTitle(1.1);
|
string | lang() |
Возвращает части локализации шаблона. Подгружает локализации из файла в папке locales, в соответствии с выбранным языком. В скобках указывается соответствие из левой части 'save' => 'Сохранить'
echo lang('save');
|
string | mb_basename() |
Тоже самое, что и basename, но позволяет работать с кириллическими именами файлов.
echo mb_basename('кириллица.jpg');
|
string | getHtmlAttributes() |
Добавляет атрибуты к тегу
// В файле template.шаблона |
void | component() |
Подключает основной файл компонента из текущего шаблона/родительского шаблона/стандартного шаблона
component('product/variant', $data)
|
void | maket() |
Метод
mgAddAction (string $hookName, string $userFunction, int $countArg, int $priority = 10)
Параметры
Описание
Метод addAction Добавляет обработчик для заданного хука.
mgAddAction('printHeader', 'userfunc', 2);
Метод
mgAddActionOnce (string $hookName, string $userFunction, int $countArg, int $priority = 10)
Параметры
Описание
Добавляет обработчик для заданного хука, если такой обработчик еще не был добавлен.
mgAddActionOnce('printHeader', 'userfunc', 2);
Метод
mgAddCustomPriceAction (string $userFunction, int $priority = 10)
Параметры
Описание
Метод mgAddCustomPriceAction Добавляет обработчик для изменения цены товара, до того как он попал в корзину.
mgAddCustomPriceAction(array(__CLASS__, 'applyRate'));
Метод
mgAddShortcode (string $shortcode, string $userFunction)
Параметры
Описание
Метод addAction Добавляет обработчик шорткода.
mgAddShortcode('buy-click', array(__CLASS__, 'buyOneClick'));
Метод
mgPageThisPlugin (string $plugin, string $userFunction)
Параметры
Описание
Добавляет обработчик для страницы плагина.
Назначенная в качестве обработчика пользовательская функция
будет, отрисовывать страницу настроек плагина.
mgPageThisPlugin(__FILE__, array(__CLASS__, 'pageSettingsPlugin'));
Метод
mgActivateThisPlugin (string $dirPlugin, string $userFunction)
Параметры
Описание
Добавляет обработчик для активации плагина,
пользовательская функция будет срабатывать тогда когда
в панели администрирования будет активирован плагин.
Является необязательным атрибутом плагина, при отсутствии этого
обработчика плагин тоже будет работать.
Функция обрабатывающая событие
не должна производить вывод (echo, print, print_r, var_dump), это нарушит
логику работы AJAX.
mgActivateThisPlugin(__FILE__, array(__CLASS__, 'activate'));
Метод
mgDeactivateThisPlugin (string $dirPlugin, string $userFunction)
Параметры
Описание
Добавляет обработчик для дезактивации плагина,
пользовательская функция будет срабатывать тогда когда
в панели администрирования будет выключен плагин.
Является необязательным атрибутом плагина, при отсутствии этого
обработчика плагин тоже будет работать.
Функция обрабатывающая событие
не должна производить вывод (echo, print, print_r, var_dump), это нарушит
логику работы AJAX.
mgDeactivateThisPlugin(__FILE__, array(__CLASS__, 'deActivate'));
Метод
mgCreateHook (string $hookName)
Параметры
Описание
Создает hook - крючок, для пользовательских функций и плагинов.
mgCreateHook('hook');
Метод
bool|void mgAddMeta (string $data, string $onlyController = all)
Параметры
Описание
Добавляет в секцию
подключение JS и CSS файлов в публичной части сайта.
mgAddMeta('<link href="'.SITE.'/mg-plugins/news/css/style.css" rel="stylesheet" type="text/css">');
mgAddMeta('<script src="../js/main.js"></script>');
mgAddMeta('<script>alert(1);</script>');
Метод
void mgExcludeMeta (string|array $data)
Параметры
Описание
Исключает из реестра mgAddMeta , указанный статичный файл
mgExcludeMeta('<link href="mg-plugins/news/css/style.css" rel="stylesheet" type="text/css">');
Метод
void setOption (array|string $option, string $value)
Параметры
Описание
Устанавливает значение для опции (настройки).
$data = array(
option => 'sitename'
value => 'moguta.ru'
)
setOption($data);
// или
setOption('sitename', 'moguta.ru');
Метод
string|array getOption (string $option, bool $data = false)
Параметры
Описание
Возвращает значение для запрошенной опции (настройки).
Имеет два режима:
1. getOption('optionName') - вернет только значение;
2. getOption('optionName', true) - вернет всю информацию об опции в
виде массива.
echo getOption('sitename'); // 'moguta.ru'
$res = getOption('sitename', true);
viewData($res);
//$res == array(
// 'option' => 'sitename', // идентификатор опции
// 'value' => 'moguta.ru', // значение опции
// 'active' => 'Y', // в будущем будет отвечать за автоподгрузку опций в кеш Y/N
// 'name' => 'Имя сайта', // метка для опции
// 'desc' => 'Настройка задает имя для сайта', // описание опции
//);
Метод
string mgMenuFull (string $type = top)
Параметры
Описание
Получить полное меню в HTML виде.
Ставится в месте вывода меню.
Метод
bool mgMeta (array $args)
Параметры
Описание
Возвращает шорткод для подготовленных мета данных (seo, ссылки на css и js файлы).
<head>
mgMeta("meta","css","jquery");
............
</head>
<body>
............
mgMeta("js");
</body>
Метод
string mgMetaInsertMode ()
Параметры
Описание
Выводит подготовленные мета данные (seo, ссылки на css и js файлы).
@ignore
Метод
string mgMetaInsert ()
Описание
Выводит все подготовленные мета данные (seo, ссылки на css и js файлы).
@ignore
Метод
void mgSEO (array $data)
Параметры
Описание
Устанавливает SEO данные страницы: title, description, keywords.
$data = array(
'meta_title' => 'Кроссовки Nike Flight Bonafide',
'meta_keywords' => 'Кроссовки Nike Flight Bonafide купить, SKU319, Кроссовки, Nike, Flight, Bonafide',
'meta_desc' => 'Описание Nike Flight Bonafide'
);
mgSEO($data);
Метод
void mgTitle (string|bool $title)
Параметры
Описание
Задает заголовок страницы.
mgTitle('Заголовок');
Метод
viewData (array $data, bool $vardump = false)
Параметры
Описание
Выводит содержимое массива на страницу
$data = array(1, 2, 5, 'data');
viewData($data);
Метод
string mgDeclensionNum (int $number, array $titles)
Параметры
Описание
Склонение числительных.
$data['searchData']['count'] = 5;
echo 'Найдено '.mgDeclensionNum($data['searchData']['count'], array('товар', 'товара', 'товаров'));
Метод
bool isStaticPage ()
Описание
Проверяет является ли страница статичной, созданной из панели администрирования
$res = isStaticPage();
var_dump($res);
Метод
mgSmallCartBlock (array $data)
Параметры
Описание
Выводит блок стандартной маленькой корзины в HTML виде.
Использует 'layout_cart' текущего шаблона.
mgSmallCartBlock($data);
Метод
mgSearchBlock ()
Описание
Выводит блок стандартного поиска в HTML виде.
Использует 'layout_search' текущего шаблона.
mgSearchBlock();
Метод
mgContactBlock ()
Описание
Выводит блок с контактами в HTML виде.
Использует 'layout_cart' текущего шаблона.
mgContactBlock();
Метод
string mgImageProduct (array $data, bool $origSize = false, string|null $mode, bool $titleNoPrint = false)
Параметры
Описание
Возвращает правильно сформированную картинку для продукта в HTML.
Со всеми параметрами, для эффекта перелета в корзину.
echo mgImageProduct($data['item'],false,'MID',true);
Метод
string mgImageProductPath (string $image, int $productId, string $size = orig)
Параметры
Описание
Функция возвращает сформированную ссылку на картинку
$res = mgImageProductPath($value["image_url"], $value['id'], 'small');
viewData($res);
Метод
mgSubCategory (int $catId)
Параметры
Описание
Возвращает список вложенных категорий в HTML виде.
Использует 'layout_subcategory' текущего шаблона.
mgSubCategory(5);
Метод
mgGalleryProduct (type $data)
Параметры
Описание
Возвращает правильно верстку картинок товара в HTML.
Использует 'layout_images' текущего шаблона.
mgGalleryProduct($data);
Метод
string mgLogo (string $alt, string $title, string $style)
Параметры
Описание
Возвращает картинку логотипа магазина, установленную в настройках.
echo mgLogo();
Метод
bool layout ($layout, $data)
Параметры
Описание
Выводит верстку содержащуюся в заданном layout.
layout('cart', $data);
Метод
filterCatalog (bool $userStyle = false)
Параметры
Описание
Возвращает html код фильтров магазина.
Работает только для разделов каталога.
filterCatalog();
Метод
copyrightMoguta ()
Описание
Возвращает html код копирайта Moguta.CMS в футере сайта
copyrightMoguta();
Метод
backgroundSite ()
Описание
Добавляет фоновое изображение, если выбрано в настройках
<body backgroundSite(); >
Метод
bool isIndex ()
Описание
Возвращает true, если открыта главная страница
$result = isIndex();
var_dump($result);
Метод
bool isCatalog ()
Описание
Возвращает true, если открыта страница каталога
$result = isCatalog();
var_dump($result);
Метод
bool isCart ()
Описание
Возвращает true, если открыта страница корзины
$result = isCart();
var_dump($result);
Метод
bool isOrder ()
Описание
Возвращает true, если открыта страница заказа
$result = isOrder();
var_dump($result);
Метод
bool isSearch ()
Описание
Возвращает true, если открыта страница поиска
$result = isSearch();
var_dump($result);
Метод
string|bool horizontMenu ()
Описание
Возвращает верстку горизонтального меню, если оно подключено в настройках
Использует 'layout_horizontmenu' текущего шаблона.
echo horizontMenu();
Метод
bool horizontMenuDisable ()
Описание
Возвращает false, если горизонтальное меню подключено в настройках
$result = horizontMenuDisable();
var_dump($result);
Метод
bool catalogToIndex ()
Описание
Возвращает значение флага, для опции вывода каталога на главной
$result = catalogToIndex();
var_dump($result);
Метод
string mgGetPaymentRateTitle (float $rate)
Параметры
Описание
Возвращает приписку с наценкой для способа оплаты
echo mgGetPaymentRateTitle(1.1);
Метод
string lang (string $phrase)
Параметры
Описание
Возвращает части локализации шаблона.
Подгружает локализации из файла в папке locales, в соответствии с выбранным языком.
В скобках указывается соответствие из левой части 'save' => 'Сохранить'
echo lang('save');
Метод
string mb_basename (string $filename)
Параметры
Описание
Тоже самое, что и basename, но позволяет работать с кириллическими именами файлов.
echo mb_basename('кириллица.jpg');
Метод
string getHtmlAttributes (string $filename)
Параметры
Описание
Добавляет атрибуты к тегу
// В файле template.шаблона
<html getHtmlAttributes()>
Метод
component (string $component, array $data, string $file)
Параметры
Описание
Подключает основной файл компонента из текущего шаблона/родительского шаблона/стандартного шаблона
component('product/variant', $data)