Пользователям Разработчикам Вопросы

Справочник для программистов

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

 
Список доступных функции движка, которые можно использовать в любом месте шаблона и плагинов
void backgroundSite() Добавляет фоновое изображение, если выбрано в настройках
bool catalogToIndex() Возвращает значение флага, для опции вывода каталога на главной
void copyrightMoguta() Возвращает html код копирайта Moguta.CMS в футере сайта
void filterCatalog() Возвращает html код фильтров магазина.
string|array getOption() Возвращает значение для запрошенной опции (настройки).
string|bool horizontMenu() Возвращает верстку горизонтального меню, если оно подключено в настройках Использует 'layout_horizontmenu' текущего шаблона.
bool horizontMenuDisable() Возвращает false, если горизонтальное меню подключено в настройках
bool isCart() Возвращает true, если открыта страница корзины
bool isCatalog() Возвращает true, если открыта страница каталога
bool isIndex() Возвращает true, если открыта главная страница
bool isOrder() Возвращает true, если открыта страница заказа
bool isSearch() Возвращает true, если открыта страница поиска
bool isStaticPage() Проверяет является ли страница статичной, созданной из панели администрирования
string lang() Возвращает части локализации шаблона.
bool layout() Выводит верстку содержащуюся в заданном layout.
void mgActivateThisPlugin() Добавляет обработчик для активации плагина, пользовательская функция будет срабатывать тогда когда в панели администрирования будет активирован плагин.
void mgAddAction() Функция addAction Добавляет обработчик для заданного хука.
void mgAddCustomPriceAction() Функция mgAddCustomPriceAction Добавляет обработчик для изменения цены товара, до того как он попал в корзину.
bool|void mgAddMeta() Добавляет переданную строку в секцию
void mgAddShortcode() Функция addAction Добавляет обработчик шорткода.
void mgContactBlock() Выводит блок с контактами в HTML виде.
void mgCreateHook() Создает hook - крючок, для пользовательских функций и плагинов.
void mgDeactivateThisPlugin() Добавляет обработчик для дезактивации плагина, пользовательская функция будет срабатывать тогда когда в панели администрирования будет выключен плагин.
string mgDeclensionNum() Склонение числительных.
void mgExcludeMeta() Исключает из реестра mgAddMeta , указанный статичный файл
void mgGalleryProduct() Возвращает правильно верстку картинок товара в HTML.
array mgGetCart() Получить товары из корзины.
string mgGetPaymentRateTitle() Возвращает приписку с наценкой для способа оплаты
string mgImageProduct() Возвращает правильно сформированную картинку для продукта в HTML.
string mgImageProductPath() Функция возвращает сформированную ссылку на картинку
string mgLogo() Возвращает картинку логотипа магазина, установленную в настройках.
string mgMenu() Получить меню в HTML виде.
string mgMenuFull() Получить полное меню в HTML виде.
bool mgMeta() Возвращает шорткод для подготовленных мета данных (seo, ссылки на css и js файлы).
void mgPageThisPlugin() Добавляет обработчик для страницы плагина.
void mgSearchBlock() Выводит блок стандартного поиска в HTML виде.
void mgSEO() Устанавливает SEO данные страницы: title, description, keywords.
void mgSmallCartBlock() Выводит блок стандартной маленькой корзины в HTML виде.
void mgSubCategory() Возвращает список вложенных категорий в HTML виде.
void mgTitle() Задает заголовок страницы.
void setOption() Устанавливает значение для опции (настройки).
void viewData() Выводит содержимое массива на страницу
Описание Функций и примеры их использования

Функция

void backgroundSite ()

Описание

Добавляет фоновое изображение, если выбрано в настройках

Пример использования

  1.    

 

 

Функция

bool catalogToIndex ()

Описание

Возвращает значение флага, для опции вывода каталога на главной

Пример использования

  1.  $result = catalogToIndex();
  2.  var_dump($result);

 

 

Функция

void copyrightMoguta ()

Описание

Возвращает html код копирайта Moguta.CMS в футере сайта

Пример использования

  1.  copyrightMoguta();

 

 

Функция

void filterCatalog ([bool $userStyle = false])

Параметры

  • $userStyle: отключает стандартные стили, позволяет задать пользовательские

Описание

Возвращает html код фильтров магазина.

Работает только для разделов каталога.

Пример использования

  1.    filterCatalog(); ?>

 

 

Функция

string|array getOption (string $option, [bool $data = false])

Параметры

  • $option: название опции
  • $data: если true, то вернет всю информацию об опции в виде массива

Описание

Возвращает значение для запрошенной опции (настройки).

Имеет два режима:
  1. getOption('optionName') - вернет только значение;
  2. getOption('optionName', true) - вернет всю информацию об опции в
виде массива.

Пример использования

  1.  echo getOption('sitename'); // 'moguta.ru'

Пример использования

  1.  $res = getOption('sitename', true);
  2.  viewData($res);
  3.  //$res == array(
  4.  //  'option' => 'sitename', // идентификатор опции
  5.  //  'value'  => 'moguta.ru', // значение опции
  6.  //  'active' => 'Y', // в будущем будет отвечать за автоподгрузку опций в кеш Y/N
  7.  //  'name' => 'Имя сайта', // метка для опции
  8.  //  'desc' => 'Настройка задает имя для сайта', // описание опции
  9.  //);

 

 

Функция

string|bool horizontMenu ()

Описание

Возвращает верстку горизонтального меню, если оно подключено в настройках Использует 'layout_horizontmenu' текущего шаблона.

Пример использования

  1.  echo horizontMenu();

 

 

Функция

bool horizontMenuDisable ()

Описание

Возвращает false, если горизонтальное меню подключено в настройках

Пример использования

  1.  $result = horizontMenuDisable();
  2.  var_dump($result);

 

 

Функция

bool isCart ()

Описание

Возвращает true, если открыта страница корзины

Пример использования

  1.  $result = isCart();
  2.  var_dump($result);

 

 

Функция

bool isCatalog ()

Описание

Возвращает true, если открыта страница каталога

Пример использования

  1.  $result = isCatalog();
  2.  var_dump($result);

 

 

Функция

bool isIndex ()

Описание

Возвращает true, если открыта главная страница

Пример использования

  1.  $result = isIndex();
  2.  var_dump($result);

 

 

Функция

bool isOrder ()

Описание

Возвращает true, если открыта страница заказа

Пример использования

  1.  $result = isOrder();
  2.  var_dump($result);

 

 

Функция

bool isSearch ()

Описание

Возвращает true, если открыта страница поиска

Пример использования

  1.  $result = isSearch();
  2.  var_dump($result);

 

 

Функция

bool isStaticPage ()

Описание

Проверяет является ли страница статичной, созданной из панели администрирования

Пример использования

  1.    $res = isStaticPage();
  2.    var_dump($res);

 

 

Функция

string lang (string $phrase)

Параметры

  • $phrase: ключ массива локализации

Описание

Возвращает части локализации шаблона.

Подгружает локализации из файла в папке locales, в соответствии с выбранным языком. В скобках указывается соответствие из левой части 'save' => 'Сохранить'

Пример использования

  1.    echo lang('save');

 

 

Функция

bool layout ($layout $layout, [$data $data = null])

Параметры

  • $layout: название верстки в папке шаблона layout, без префикса 'layout_'
  • $data: массив данных переданных в layout'

Описание

Выводит верстку содержащуюся в заданном layout.

Пример использования

  1.    layout('cart', $data);

 

 

Функция

void mgActivateThisPlugin (string $dirPlugin, string $userFunction)

Параметры

  • $dirPlugin: директория, в которой хранится плагин.
  • $userFunction: пользовательская функция, которая сработает при объявлении хука.

Описание

Добавляет обработчик для активации плагина, пользовательская функция будет срабатывать тогда когда в панели администрирования будет активирован плагин.

>Является необязательным атрибутом плагина, при отсутствии этого обработчика плагин тоже будет работать.

 

Функция обрабатывающая событие не должна производить вывод (echo, print, print_r, var_dump), это нарушит логику работы AJAX.

 

Пример использования

  1.    mgActivateThisPlugin(__FILE__, array(__CLASS__, 'activate'));

 

 

Функция

void mgAddAction (string $hookName, string $userFunction, [int $countArg = 0], [int $priority = 10])

Параметры

  • $hookName: имя хука, на который вешается обработчик.
  • $userFunction: пользовательская функции, которая сработает при объявлении хука.
  • $countArg: количество аргументов, которое ждет пользовательская функция.
  • $priority: приоритет выполнения пользовательская функция.

Описание

Функция addAction Добавляет обработчик для заданного хука.

Пример использования

  1.    mgAddAction('printHeader', 'userfunc', 2);

 

 

Функция

void mgAddCustomPriceAction (string $userFunction, [int $priority = 10])

Параметры

  • $userFunction: название функции обработчика, или массив вида (Класс, Имя функции обработчика в классе)
  • $priority: приоритет выполнения функции

Описание

Функция mgAddCustomPriceAction Добавляет обработчик для изменения цены товара, до того как он попал в корзину.

Пример использования

  1.    mgAddCustomPriceAction(array(__CLASS__, 'applyRate'));

 

 

Функция

bool|void mgAddMeta (string $data, [string $onlyController = 'all'])

Параметры

  • $data: строковая переменная, с данными.
  • $onlyController: подключать только для заданного контролера.

Описание

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

backgroundSite(); ?>>

Пример использования

  1.    mgAddMeta('
    ');

 

 

Функция

void mgAddShortcode (string $shortcode, string $userFunction)

Параметры

  • $shortcode: название шорткода.
  • $userFunction: пользовательская функции, которая сработает при встрече [названия шорткода].

Описание

Функция addAction Добавляет обработчик шорткода.

Пример использования

  1.    mgAddShortcode('buy-click', array(__CLASS__, 'buyOneClick'));

 

 

Функция

void mgContactBlock ()

Описание

Выводит блок с контактами в HTML виде.

Использует 'layout_cart' текущего шаблона.

Пример использования

  1.  mgContactBlock();

 

 

Функция

void mgCreateHook (string $hookName)

Параметры

  • $hookName: функция из плагина для выполнения

Описание

Создает hook - крючок, для пользовательских функций и плагинов.

Пример использования

  1.    mgCreateHook('hook');

 

 

Функция

void mgDeactivateThisPlugin (string $dirPlugin, string $userFunction)

Параметры

  • $dirPlugin: директория, в которой хранится плагин.
  • $userFunction: пользовательская функция, которая сработает при объявлении хука.

Описание

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

>Является необязательным атрибутом плагина, при отсутствии этого обработчика плагин тоже будет работать.

 

Функция обрабатывающая событие не должна производить вывод (echo, print, print_r, var_dump), это нарушит логику работы AJAX.

 

Пример использования

  1.    mgDeactivateThisPlugin(__FILE__, array(__CLASS__, 'deActivate'));

 

 

Функция

string mgDeclensionNum (int $number, array $titles)

Параметры

  • $number: количество
  • $titles: массив для склонения, например: array('товар', 'товара', 'товаров')

Описание

Склонение числительных.

Пример использования

  1.  $data['searchData']['count'] = 5;
  2.  echo 'Найдено '.mgDeclensionNum($data['searchData']['count'], array('товар', 'товара', 'товаров'));

 

 

Функция

void mgExcludeMeta (string|array $data)

Параметры

  • $data: строковая переменная с данными, либо массив.

Описание

Исключает из реестра mgAddMeta , указанный статичный файл

Пример использования

  1.    mgExcludeMeta('
    ');

 

 

Функция

void mgGalleryProduct (type $data)

Параметры

  • $data: параметры товара

Описание

Возвращает правильно верстку картинок товара в HTML.

Использует 'layout_images' текущего шаблона.

Пример использования

  1.    mgGalleryProduct($data);

 

 

Функция

array mgGetCart ()

Описание

Получить товары из корзины.

Пример использования

  1.    $res = mgGetCart();
  2.    viewData($res);

 

 

Функция

string mgGetPaymentRateTitle (float $rate)

Параметры

  • $rate: коэффициент наценки

Описание

Возвращает приписку с наценкой для способа оплаты

Пример использования

  1.    echo mgGetPaymentRateTitle(1.1);

 

 

Функция

string mgImageProduct (array $data, [bool $origSize = false], [string|null $mode = null], [bool $titleNoPrint = false])

Параметры

  • $data: массив с параметрами товара
  • $origSize: использовать оригинальное изображение
  • $mode: какую миниатюру использовать ('MIN', 'MID' или 'MAX'(оригинальное изображение))
  • $titleNoPrint: не выводить аттрибут title у изображения

Описание

Возвращает правильно сформированную картинку для продукта в HTML.

Со всеми параметрами, для эффекта перелета в корзину.

Пример использования

  1.    echo mgImageProduct($data['item'],false,'MID',true);

 

 

Функция

string mgImageProductPath (string $image, int $productId, [string $size = 'orig'])

Параметры

  • $image: имя изображения
  • $productId: id товара
  • $size: размер: small/big/orig - не обязательный

Описание

Функция возвращает сформированную ссылку на картинку

Пример использования

  1.    $res = mgImageProductPath($value["image_url"], $value['id'], 'small');
  2.    viewData($res);

 

 

Функция

string mgLogo ([string $alt = ''], [string $title = ''], [string $style = ''])

Параметры

  • $alt: параметр alt
  • $title: параметр title
  • $style: дополнительные стили

Описание

Возвращает картинку логотипа магазина, установленную в настройках.

Пример использования

  1.    echo mgLogo();

 

 

Функция

string mgMenu ()

Описание

Получить меню в HTML виде.

Ставится в месте вывода меню.

Пример использования

  1.    mgMenu();

 

 

Функция

string mgMenuFull ([string $type = 'top'])

Параметры

  • $type: тип меню

Описание

Получить полное меню в HTML виде.

Ставится в месте вывода меню.

 

 

Функция

bool mgMeta ([array $args = null])

Параметры

  • $args: массив с указанием, какие мета данные вернуть (meta(seo), css, js, jquery)

Описание

Возвращает шорткод для подготовленных мета данных (seo, ссылки на css и js файлы).

Пример использования

  1.  
  •    mgMeta("meta","css","jquery"); ?>
  •    ............
  •  
  •  
 
  •    ............
  •    mgMeta("js"); ?>
  •  

 

 

Функция

void mgPageThisPlugin (string $plugin, string $userFunction)

Параметры

  • $plugin: название папки, в которой лежит плагин.
  • $userFunction: пользовательская функция, которая сработает при открытии страницы настроек данного плагина.

Описание

Добавляет обработчик для страницы плагина.

Назначенная в качестве обработчика пользовательская функция будет, отрисовывать страницу настроек плагина.

Пример использования

  1.    mgPageThisPlugin(__FILE__, array(__CLASS__, 'pageSettingsPlugin'));

 

 

Функция

void mgSearchBlock ()

Описание

Выводит блок стандартного поиска в HTML виде.

Использует 'layout_search' текущего шаблона.

Пример использования

  1.  mgSearchBlock();

 

 

Функция

void mgSEO (array $data)

Параметры

  • $data: массив с SEO данными.

Описание

Устанавливает SEO данные страницы: title, description, keywords.

Пример использования

  1.  $data = array(
  2.    'meta_title' => 'Кроссовки Nike Flight Bonafide',
  3.    'meta_keywords' => 'Кроссовки Nike Flight Bonafide купить, SKU319, Кроссовки, Nike, Flight, Bonafide',
  4.    'meta_desc' => 'Описание Nike Flight Bonafide'
  5.  );
  6.  mgSEO($data);

 

 

Функция

void mgSmallCartBlock (array $data)

Параметры

  • $data: массив с данными для корзины

Описание

Выводит блок стандартной маленькой корзины в HTML виде.

Использует 'layout_cart' текущего шаблона.

Пример использования

  1.  mgSmallCartBlock($data);

 

 

Функция

void mgSubCategory (int $catId)

Параметры

  • $catId: id родительской категории.

Описание

Возвращает список вложенных категорий в HTML виде.

Использует 'layout_subcategory' текущего шаблона.

Пример использования

  1.    mgSubCategory(5);

 

 

Функция

void mgTitle (string|bool $title)

Параметры

  • $title: заголовок страницы.

Описание

Задает заголовок страницы.

Пример использования

  1.    mgTitle('Заголовок');

 

 

Функция

void setOption (array|string $option, [string $value = ''])

Параметры

  • $option: - значения для полей таблицы с настройками или название опции.
  • $value: - значение опции, указывается только если первый параметр строковой и означает название опции.

Описание

Устанавливает значение для опции (настройки).

Пример использования

  1.  $data = array(
  2.    option => 'sitename'
  3.    value  => 'moguta.ru'
  4.  )
  5.  setOption($data);
  6.  // или
  7.  setOption('sitename', 'moguta.ru');

 

 

Функция

void viewData (array $data)

Параметры

Описание

Выводит содержимое массива на страницу

Пример использования

  1.  $data = array(1, 2, 5, 'data');
  2.  viewData($data);

 

 

2012-2024 год. Все права защищены.
Сайт работает на движке:   Moguta.CMS