Docs For Class Category

Category

Описание

Класс Category - совершает все операции с категориями товаров.

  • Создает новую категорию;
  • Удаляет категорию;
  • Редактирует категорию;
  • Возвращает список id всех вложенных категорий;
  • Возвращает древовидный список категорий, пригодный для использования в меню;
  • Возвращает массив id категории и ее заголовок;
  • Возвращает иерархический массив категорий;
  • Возвращает отдельные пункты списка заголовков категорий.
  • Генерирует UL список категорий для вывода в меню.
  • Экземпляр класса категорий хранится в реестре класс MG

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

    1.  //пример вызова метода getCategoryListUl() из любого места в коде.
    2.  MG::get('category')->getCategoryListUl()

Методы класса
bool|int addCategory() Создает новую категорию.
void addToCsvLine() По входящим данным формирует новую строку CSV файла, в требуемом формате.
bool applyRateToSubCategory() Применяет скидку/наценку ко всем вложенным подкатегориям.
bool changeSortCat() Меняет местами параметры сортировки двух категории.
bool clearCategoryRate() Отменяет скидки и наценки для выбранной категории.
bool delCategory() Удаляет категорию.
void exportToCsv() Выгрузка категории в CSV.
array getArrayCategory() Возвращает массив всех категорий каталога.
string getCategoriesHorHTML() Возвращает закэшированное горизонтальное меню категорий.
string getCategoriesHTML() Возвращает закэшированное левое меню категорий.
array getCategoryById() Получает параметры категори по его Id.
array getCategoryByUrl() Получает параметры категори по его URL.
int getCategoryCount() Возвращает общее количество категорий каталога.
array getCategoryList() Возвращает список только id всех вложеных категорий.
string getCategoryListUl() Возвращает древовидный список категорий, пригодный для использования в меню.
array getCategoryTitleList() Возвращает массив id категории и ее заголовок.
string. getChildCategoryIds() Возвращает массив вложенных категорий первого уровня.
array getDesctiption() Получает описание категории.
array getHierarchyCategory() Возвращает иерархический массив категорий.
string getHtmlPageRow() возвращает html верстку строк для таблицы с категориями.
string getHtmlPageRowSimple() возвращает html верстку строк для таблицы с категориями (упрощенный).
string getImageCategory() Получает изображение категории.
string getPages() Возвращает строки для таблицы с категориями в админке.
string getPagesSimple() возвращает строки для таблицы с категориями (упрощенный).
string getParentUrl() Возвращает полный url категории по ее id.
array getPropertyForCategoryById() Возвращает массив id всех характеристик для заданной категории.
string getTitleCategory() Возвращает отдельные пункты списка заголовков категорий.
array getUserPropertyCategoryById() Возвращает массив пользовательских характеристик для заданной категории.
void rowCsvPrintToFile() Записывает построчно CSV выгрузку в файл data_csv_m_d_Y.csv в корневую папку сайта.
int sort() Упорядочивает категорию по сортировке.
void sortToAdd() Сортировка по порядку добавления категорий на сайт.
void sortToAlphabet() Сортировка по алфавиту.
bool|int updateCategory() Изменяет данные о категории.
Описание методов и примеры их использования

Метод

bool|int addCategory (array $array)

Параметры

  • $array: массив с данными о категории.

Описание

Создает новую категорию.

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

  1.   $array array(
  2.     'id' => ,              // id
  3.     'unit' => 'шт.',       // единица измерения товаров
  4.     'title' => 123,        // название категории
  5.     'url' => 123,          // url последней секции категории
  6.     'parent' => 0,         // id родительской категории
  7.     'html_content' => ,    // описание категории
  8.     'meta_title' => ,      // заголовок страницы
  9.     'meta_keywords' => ,   // ключевые слова
  10.     'meta_desc' => ,       // мета описание
  11.     'image_url' => ,       // ссылка на изображение
  12.     'menu_icon' => ,       // ссылка на иконку меню
  13.     'invisible' => 0,      // параметр видимости
  14.     'rate' => 0,           // наценка
  15.     'seo_content' => ,     // seo контент
  16.     'seo_alt' => ,         // seo
  17.     'seo_title' => ,       // seo
  18.     'parent_url' => ,      // url родительской категории
  19.   );
  20.   $res MG::get('category')->addCategory($array);
  21.   viewData($res);

Метод

void addToCsvLine (array $row)

Параметры

  • $row: массив со всеми данными о категории.

Описание

По входящим данным формирует новую строку CSV файла, в требуемом формате.

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

  1.   $array array(
  2.     'title' => 'Смартфоны',                  // название категории
  3.     'url' => 'smartfony',                    // url
  4.     'parent' => 0,                           // id родительской категори
  5.     'parent_url' => ,                        // родительский url
  6.     'html_content' => ,                      // содеражние страницы
  7.     'image_url' => '/uploads/cat_smart.png'// ссылка на изображение
  8.     'meta_title' => ,                        // заголовок страницы
  9.     'meta_keywords' => ,                     // ключевые слова
  10.     'meta_desc' => ,                         // мета описание
  11.     'seo_content' => ,                       // seo контент
  12.     'rate' => 0,                             // наценка
  13.     'invisible' => 0,                        // параметр видимости
  14.     'activity' => 1,                         // параметр активности
  15.     'export' => 1,                           //
  16.     'sort' => 1,                             // порядок сортировки
  17.     '1c_id' => ,                             // идентификатор в 1с
  18.     'id' => 1,                               // id
  19.     'seo_title' => ,                         // seo title
  20.     'seo_alt' => ,                           // seo alt
  21.   );
  22.   $res MG::get('category')->addToCsvLine($array);
  23.   viewData($res);

Метод

bool applyRateToSubCategory (id $id)

Параметры

  • $id: - id текущей категории

Описание

Применяет скидку/наценку ко всем вложенным подкатегориям.

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

  1.   $res MG::get('category')->applyRateToSubCategory(12);
  2.   viewData($res);

Метод

bool changeSortCat (int $oneId, int $twoId)

Параметры

  • $oneId: - id первой категории.
  • $twoId: - id второй категории.

Описание

Меняет местами параметры сортировки двух категории.

Метод

bool clearCategoryRate (int $id)

Параметры

  • $id: id категории

Описание

Отменяет скидки и наценки для выбранной категории.

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

  1.   $res MG::get('category')->clearCategoryRate(12);
  2.   viewData($res);

Метод

bool delCategory (int $id)

Параметры

  • $id: id удаляемой категории.

Описание

Удаляет категорию.

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

  1.   $res MG::get('category')->delCategory(12);
  2.   viewData($res);

Метод

void exportToCsv ()

Описание

Выгрузка категории в CSV.

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

  1.   MG::get('category')->exportToCsv();

Метод

array getArrayCategory ()

Описание

Возвращает массив всех категорий каталога.

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

  1.   $res MG::get('category')->getArrayCategory();
  2.   viewData($res);

Метод

string getCategoriesHorHTML ()

Описание

Возвращает закэшированное горизонтальное меню категорий.

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

  1.   $res MG::get('category')->getCategoriesHorHTML();
  2.   viewData($res);

Метод

string getCategoriesHTML ()

Описание

Возвращает закэшированное левое меню категорий.

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

  1.   $res MG::get('category')->getCategoriesHTML();
  2.   viewData($res);

Метод

array getCategoryById (string $id)

Параметры

  • $id: запрашиваемой категории.

Описание

Получает параметры категори по его Id.

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

  1.   $res MG::get('category')->getCategoryById(12);
  2.   viewData($res);

Метод

array getCategoryByUrl (string $url, [string $parentUrl = ""])

Параметры

  • $url: запрашиваемой категории.
  • $parentUrl: родительской категории.

Описание

Получает параметры категори по его URL.

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

  1.   $url 'chasy-sekundomery-shagomery';
  2.   $parentUrl 'aksessuary';
  3.   $res MG::get('category')->getCategoryByUrl($url$parentUrl);
  4.   viewData($res);

Метод

int getCategoryCount ()

Описание

Возвращает общее количество категорий каталога.

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

  1.   $res MG::get('category')->getCategoryCount();
  2.   viewData($res);

Метод

array getCategoryList ([int $parent = 0])

Параметры

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

Описание

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

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

  1.   $parentId 5// id родительской категории
  2.   $res MG::get('category')->getCategoryList($parentId);
  3.   viewData($res);

Метод

string getCategoryListUl ([int $parent = 0], [int $type = 'public'], [bool $recursion = true])

Параметры

  • $parent: id категории, для которой надо вернуть список.
  • $type: тип списка (для публичной части, либо для админки).
  • $recursion: использовать рекурсию.

Описание

Возвращает древовидный список категорий, пригодный для использования в меню.

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

  1.   $res MG::get('category')->getCategoryListUl();
  2.   viewData($res);

Метод

array getCategoryTitleList ()

Описание

Возвращает массив id категории и ее заголовок.

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

  1.   $res MG::get('category')->getCategoryTitleList();
  2.   viewData($res);

Метод

string. getChildCategoryIds ([ $parentId = 0], int $parent)

Параметры

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

Описание

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

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

  1.   $parentId 5// id родительской категории
  2.   $res MG::get('category')->getChildCategoryIds($parentId);
  3.   viewData($res);

Метод

array getDesctiption (int $id)

Параметры

  • $id: id категории

Описание

Получает описание категории.

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

  1.   $res MG::get('category')->getDesctiption(12);
  2.   viewData($res);

Метод

array getHierarchyCategory ([int $parent = 0], [bool $onlyActive = false])

Параметры

  • $parent: id родительской категории.
  • $onlyActive: возвращать только активные категории.

Описание

Возвращает иерархический массив категорий.

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

  1.   $res MG::get('category')->getHierarchyCategory();
  2.   viewData($res);

Метод

string getHtmlPageRow (array $pages, int $id, int $level)

Параметры

  • $pages: массив с информацие о категориях
  • $id: id категории
  • $level: уровень вложенности

Описание

возвращает html верстку строк для таблицы с категориями.

Метод

string getHtmlPageRowSimple (array $pages, int $id, int $level)

Параметры

  • $pages: массив с информацие о категориях
  • $id: id категории
  • $level: уровень вложенности

Описание

возвращает html верстку строк для таблицы с категориями (упрощенный).

Метод

string getImageCategory (int $id)

Параметры

  • $id: id категории

Описание

Получает изображение категории.

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

  1.   $res MG::get('category')->getImageCategory(12);
  2.   viewData($res);

Метод

string getPages (array $pagesArray, int $parentLevel, int $parent)

Параметры

  • $pagesArray: массив с информацие о категориях
  • $parentLevel: уровень вложенности родительской страницы
  • $parent: id родительской характеристики

Описание

Возвращает строки для таблицы с категориями в админке.

Метод

string getPagesSimple (array $pagesArray, int $parentLevel, int $parent)

Параметры

  • $pagesArray: массив с информацие о категориях
  • $parentLevel: уровень вложенности родительской страницы
  • $parent: id родительской характеристики

Описание

возвращает строки для таблицы с категориями (упрощенный).

Метод

string getParentUrl ($parentId $parentId)

Параметры

  • $parentId: - id категории для которой нужно найти UR родителя.

Описание

Возвращает полный url категории по ее id.

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

  1.   $res MG::get('category')->getParentUrl(12);
  2.   viewData($res);

Метод

array getPropertyForCategoryById (string $id)

Параметры

  • $id: запрашиваемой категории.

Описание

Возвращает массив id всех характеристик для заданной категории.

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

  1.   $res MG::get('category')->getPropertyForCategoryById(12);
  2.   viewData($res);

Метод

string getTitleCategory (array $arrayCategories, [int $selectCategory = 0], [bool $modeArray = false], [string $prefix = ' -- '])

Параметры

  • $arrayCategories: массив с категориями.
  • $selectCategory: id выбранной категории.
  • $modeArray: - если установлен этот флаг, то результат вернет массив а не HTML список
  • $prefix: префикс для подкатегорий

Описание

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

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

  1.   $arrayCategories MG::get('category')->getArrayCategory();
  2.   $res MG::get('category')->getTitleCategory($arrayCategories);
  3.   viewData($res);

Метод

array getUserPropertyCategoryById (string $id)

Параметры

  • $id: запрашиваемой категории.

Описание

Возвращает массив пользовательских характеристик для заданной категории.

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

  1.   $res MG::get('category')->getUserPropertyCategoryById(12);
  2.   viewData($res);

Метод

void rowCsvPrintToFile (string $csvText, [bool $new = false])

Параметры

  • $csvText: csv строка.
  • $new: записывать в конец файла.

Описание

Записывает построчно CSV выгрузку в файл data_csv_m_d_Y.csv в корневую папку сайта.

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

  1.   $csvText MG::get('category')->addToCsvLine($array);
  2.   MG::get('category')->rowCsvPrintToFile($csvText);
  3.   viewData($res);

Метод

int sort (array $a, array $b)

Параметры

  • $a: первая категория
  • $b: вторая категория

Описание

Упорядочивает категорию по сортировке.

Метод

void sortToAdd ()

Описание

Сортировка по порядку добавления категорий на сайт.

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

  1.   MG::get('category')->sortToAdd();

Метод

void sortToAlphabet ()

Описание

Сортировка по алфавиту.

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

  1.   MG::get('category')->sortToAlphabet();

Метод

bool|int updateCategory (array $array)

Параметры

  • $array: массив с данными о категории.

Описание

Изменяет данные о категории.

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

  1.   $array array(
  2.     'id' => ,              // id
  3.     'unit' => 'шт.',       // единица измерения товаров
  4.     'title' => 123,        // название категории
  5.     'url' => 123,          // url последней секции категории
  6.     'parent' => 0,         // id родительской категории
  7.     'html_content' => ,    // описание категории
  8.     'meta_title' => ,      // заголовок страницы
  9.     'meta_keywords' => ,   // ключевые слова
  10.     'meta_desc' => ,       // мета описание
  11.     'image_url' => ,       // ссылка на изображение
  12.     'menu_icon' => ,       // ссылка на иконку меню
  13.     'invisible' => 0,      // параметр видимости
  14.     'rate' => 0,           // наценка
  15.     'seo_content' => ,     // seo контент
  16.     'seo_alt' => ,         // seo
  17.     'seo_title' => ,       // seo
  18.     'parent_url' => ,      // url родительской категории
  19.   );
  20.   $res MG::get('category')->updateCategory($array);
  21.   viewData($res);