Описание функций - Модуль Интеграция с iiko

События

OnBuildOrderParamsArray - событие при сборке промежуточного массива параметров заказа

Событие возникает при сборке массива параметров заказа. Функция может вернуть измененный массив. Это промежуточный, а не окончательный массив данных для передачи данных в iiko, окончательный массив можно изменить по событию OnBuildIikoOrderBody.

Входные параметры:

Пример обработки события:

namespace Partner;



\Bitrix\Main\EventManager::getInstance()->addEventHandler( 

    'grain.iiko', 

    'OnBuildOrderParamsArray', 

    '\Partner\IikoOrderEvents::onBuildOrderParamsArray'

); 



class IikoOrderEvents

{

    function onBuildOrderParamsArray(\Bitrix\Main\Event $event) 

    {

        $restaurant = $event->getParameter('RESTAURANT');

        $order = $event->getParameter('ORDER');

        $params = $event->getParameter('PARAMS');

        $check = $event->getParameter('CHECK');



        // изменяем массив $params 



        $result = new \Bitrix\Main\EventResult(\Bitrix\Main\EventResult::SUCCESS, $params);

        return $result;

    }

}

OnBuildIikoOrderBody - событие при сборке окончательного массива параметров заказа

Событие возникает при сборке окончательного массива данных для передачи данных в iiko. Функция может вернуть измененный массив.

Входные параметры:

Пример обработки события:

namespace Partner;



\Bitrix\Main\EventManager::getInstance()->addEventHandler( 

    'grain.iiko', 

    'OnBuildIikoOrderBody', 

    '\Partner\IikoOrderEvents::onBuildIikoOrderBody'

); 



class IikoOrderEvents

{

    function onBuildIikoOrderBody(\Bitrix\Main\Event $event) 

    {

        $restaurant = $event->getParameter('RESTAURANT');

        $order = $event->getParameter('ORDER');

        $params = $event->getParameter('PARAMS');

        $body = $event->getParameter('BODY');

        $check = $event->getParameter('CHECK');



        // изменяем массив $body



        $result = new \Bitrix\Main\EventResult(\Bitrix\Main\EventResult::SUCCESS, $body);

        return $result;

    }

}

Классы и функции

\Grain\Iiko\Restaurants - класс для работы с ресторанами

Ресторан в рамках модуля является элементом инфоблока, под ID ресторана подразумевается ID элемента инфоблока. ID ресторана в системе iiko сохраняется в поле "Внешний код" (XML_ID) элемента инфоблока и по нему осуществляется синхронизация.

При синхронизации также создаются и заполняются следующие свойства ресторанов:

\Grain\Iiko\Restaurants\getRestaurantByProductId - получение массива ресторана по ID блюда

Возвращает массив с основными полями ресторана (NAME, ID, XML_ID) по ID блюда.

\Grain\Iiko\Restaurants::getRestaurantByProductIblockId - получение массива ресторана по ID инфоблока блюд

Возвращает массив с основными полями ресторана (NAME, ID, XML_ID) по ID инфоблока блюда.

\Grain\Iiko\Restaurants::getRestaurantByOrder - получение массива ресторана из объекта заказа

Возвращает массив с основными полями ресторана (NAME, ID, XML_ID) по объекту заказа.

\Grain\Iiko\Restaurants::getRestaurantByBasketItem - получение массива ресторана из объекта позиции корзины

Возвращает массив с основными полями ресторана (NAME, ID, XML_ID) по объекту позиции корзины.

\Grain\Iiko\Restaurants::getRestaurantList - получение списка ресторанов

Возвращает список ресторанов в виде вложенных массивов (NAME, ID, XML_ID) по объекту позиции корзины.

\Grain\Iiko\Restaurants::getRestaurantById - получение массива ресторана по ID

Возвращает массив с основными полями ресторана (NAME, ID, XML_ID) по ID ресторана.

Grain\Iiko\Restaurants::sync - синхронизация ресторанов

Выполняет синхронизацию ресторанов.

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

Функция не имеет параметров.

\Grain\Iiko\Dishes - класс для работы с блюдами ресторана

Блюдо в рамках модуля является элементом инфоблока, под ID блюда подразумевается ID элемента инфоблока. ID блюда в системе iiko сохраняется в поле "Внешний код" (XML_ID) элемента инфоблока и по нему осуществляется синхронизация блюд.

При синхронизации также создаются и заполняются следующие свойства блюд:

\Grain\Iiko\Dishes::sync - синхронизация блюд

Выполняет синхронизацию блюд.

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

Функция не имеет параметров.

\Grain\Iiko\Location - класс для работы с базой адресов зоны доставки

\Grain\Iiko\Location::sync - синхронизация зон доставки

Выполняет синхронизацию адресов зон доставки.

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

Функция не имеет параметров.

\Grain\Iiko\Modifier - работа с модификаторами

\Grain\Iiko\Modifier::get - получение массива модификаторов по ID или массиву элемента

Возвращает массив модификаторов блюда.

Пример результата:

Array

(

    [0] => Array

        (

            [maxAmount] => 1

            [minAmount] => 0

            [modifierId] => 55d3bd31-99c8-4ea1-b27c-1fdb6587d87a

            [required] => 

            [defaultAmount] => 0

            [hideIfDefaultAmount] => 

            [groupId] => de5f8326-5c2f-4662-b218-79430115ba90

            [groupName] => Оливье

            [groupRequired] => 1

            [groupMinAmount] => 1

            [groupMaxAmount] => 1

            [m] => Array

                (

                    [additionalInfo] => 

                    [code] => 03626

                    [description] => 

                    [id] => 55d3bd31-99c8-4ea1-b27c-1fdb6587d87a

                    [isDeleted] => 

                    [name] => Малая порция

                    [seoDescription] => 

                    [seoKeywords] => 

                    [seoText] => 

                    [seoTitle] => 

                    [tags] => 

                    [carbohydrateAmount] => 8.079

                    [carbohydrateFullAmount] => 80.79

                    [differentPricesOn] => Array

                        (

                        )



                    [doNotPrintInCheque] => 

                    [energyAmount] => 144.006

                    [energyFullAmount] => 1440.06

                    [fatAmount] => 7.863

                    [fatFullAmount] => 78.63

                    [fiberAmount] => 10.039

                    [fiberFullAmount] => 100.39

                    [groupId] => de5f8326-5c2f-4662-b218-79430115ba90

                    [groupModifiers] => Array

                        (

                        )



                    [measureUnit] => порц

                    [modifiers] => Array

                        (

                        )



                    [price] => 350

                    [productCategoryId] => 0e9ab194-1ef5-4854-0172-b4889f507477

                    [prohibitedToSaleOn] => Array

                        (

                        )



                    [type] => modifier

                    [useBalanceForSell] => 

                    [weight] => 1

                    [images] => 

                    [isIncludedInMenu] => 1

                    [order] => 0

                    [parentGroup] => 

                    [warningType] => 0

                )



            [selected] => 1

        )



    [1] => Array

        (

            [maxAmount] => 1

            [minAmount] => 0

            [modifierId] => 6de49eff-3d87-463c-b987-261a64e4a127

            [required] => 

            [defaultAmount] => 0

            [hideIfDefaultAmount] => 

            [groupId] => de5f8326-5c2f-4662-b218-79430115ba90

            [groupName] => Оливье

            [groupRequired] => 1

            [groupMinAmount] => 1

            [groupMaxAmount] => 1

            [m] => Array

                (

                    [additionalInfo] => 

                    [code] => 03628

                    [description] => 

                    [id] => 6de49eff-3d87-463c-b987-261a64e4a127

                    [isDeleted] => 

                    [name] => Большая порция

                    [seoDescription] => 

                    [seoKeywords] => 

                    [seoText] => 

                    [seoTitle] => 

                    [tags] => 

                    [carbohydrateAmount] => 8.079

                    [carbohydrateFullAmount] => 121.185

                    [differentPricesOn] => Array

                        (

                        )



                    [doNotPrintInCheque] => 

                    [energyAmount] => 144.006

                    [energyFullAmount] => 2160.09

                    [fatAmount] => 7.863

                    [fatFullAmount] => 117.945

                    [fiberAmount] => 10.039

                    [fiberFullAmount] => 150.585

                    [groupId] => de5f8326-5c2f-4662-b218-79430115ba90

                    [groupModifiers] => Array

                        (

                        )



                    [measureUnit] => порц

                    [modifiers] => Array

                        (

                        )



                    [price] => 990

                    [productCategoryId] => 0e9ab194-1ef5-4854-0172-b4889f507477

                    [prohibitedToSaleOn] => Array

                        (

                        )



                    [type] => modifier

                    [useBalanceForSell] => 

                    [weight] => 1.5

                    [images] => 

                    [isIncludedInMenu] => 1

                    [order] => 0

                    [parentGroup] => 

                    [warningType] => 0

                )



            [selected] => 0

        )



)

\Grain\Iiko\Modifier::getRequired - получение массива обязательных модификаторов для элемента

Возвращает массив обязательных модификаторов с необходимым минимальным количеством для быстрого добавления в корзину. Возвращаемый результат аналогичен функции \Grain\Iiko\Modifier::get.

\Grain\Iiko\Modifier::getRequiredModifierProps - получение массива свойств корзины для обязательных модификаторов элемента

\Grain\Iiko\Modifier::getRequiredModifiersPrice - получение стоимости обязательных модификаторов элемента

Возвращает минимальную стоимость обязательных модификаторов в виде числа с плавающей точкой (float).

\Grain\Iiko\Modifier::getPreparedForOrder - получение массива модификаторов, подготовленного для заказа, по ID или массиву элемента

\Grain\Iiko\Modifier::setModifierQuantity - установка количества для модификатора в позиции корзины

Устанавливает количество модификатора для позиции корзины.

\Grain\Iiko\Modifier::getBasketPropertyValue - получение значения свойства позиции корзины

Вспомогательная функция. Позволяет получить значение свойства позиции корзины модуля интернет-магазина.

\Grain\Iiko\Modifier::getBasketPropertyValues - получение значений всех свойств позиции корзины

Вспомогательная функция. Позволяет получить значение всех свойств позиции корзины модуля интернет-магазина.

\Grain\Iiko\Modifier::saveBasketProperty - сохранение значения свойства позиции корзины

Вспомогательная функция. Позволяет сохранить значение свойства позиции корзины модуля интернет-магазина.

\Grain\Iiko\Modifier::deleteBasketProperty - удаление свойства позиции корзины

Вспомогательная функция. Позволяет удалить свойство позиции корзины модуля интернет-магазина.

\Grain\Iiko\Modifier::getGroupTree - получение дерева групп модификаторов для ресторана

Возвращает список групп модификаторов ресторана в виде развернутого дерева.

\Grain\Iiko\Modifier::getTree - получение дерева модификаторов для ресторана

Возвращает список модификаторов ресторана в виде развернутого дерева с учетом групп модификаторов.

\Grain\Iiko\Modifier::isModifierActive - проверка активности модификатора

Проверяет, активен ли модификатор и возвращает булевое значение. Функция имеет кеширование в статической переменной для множественного обращения внутри цикла.

\Grain\Iiko\ModifierListTable - ORM класс для сохранения списка модификаторов

Данный класс предназначен для сохранения списка модификаторов для ресторанов. Для обращения можно использовать стандартный функции ORM getList, add, update, delete и др.

\Grain\Iiko\ModifierListGroupTable - ORM класс для сохранения групп модификаторов

Данный класс предназначен для сохранения дерева групп модификаторов для ресторанов. Для обращения можно использовать стандартный функции ORM getList, add, update, delete и др.

\Grain\Iiko\Rest - класс для выполнения запросов к api iiko

Класс предназначен для выполнения запросов к api системы iiko.

\Grain\Iiko\Rest::query - запрос к api iiko

Позволяет выполнить запрос к api iiko. Список методов и их параметров можно найти в документации iiko.