VK: Документирующие комментарии товаров

OPI/src/CommonModules/OPI_VK/Module.bsl

@@ -784,6 +784,13 @@
 
 #Область РаботаСТоварами
 
+// Получить список категорий товаров.
+// 
+// Параметры:
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  Соответствие Из Строка - Ключ - ID, Значение - Имя
 Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -804,6 +811,14 @@
     
 КонецФункции
 
+// Получить список товаров.
+// 
+// Параметры:
+//  Альбом - Строка,Число - ID альбома, если нужен
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  Соответствие Из КлючИЗначение - Массив соответствий товаров
 Функция ПолучитьСписокТоваров(Знач Альбом = "", Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -822,10 +837,19 @@
     
 КонецФункции
 
+// Получить товары по ИД.
+// 
+// Параметры:
+//  Товары - Строка, Массив Из Строка - ID товара или массив ID товаров
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера 
 Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт
     
     Параметры_    = ПолучитьСтандартныеПараметры(Параметры);
     СтрокаТоваров = "";
+    Owner         = "owner_id";
     
     Если ТипЗнч(Товары) <> Тип("Массив") Тогда    
         Товар   = Товары;
@@ -834,7 +858,7 @@
     КонецЕсли;
     
     Для Каждого Товар Из Товары Цикл       
-        ТекущийТовар  = Параметры["owner_id"] + "_" + Товар;
+        ТекущийТовар  = Параметры[Owner] + "_" + Товар;
         ТекущийТовар  = OPI_Инструменты.ЧислоВСтроку(ТекущийТовар);
         СтрокаТоваров = СтрокаТоваров + ТекущийТовар + ",";
     КонецЦикла;
@@ -849,14 +873,41 @@
      
 КонецФункции
 
+// Добавить товар.
+// 
+// Параметры:
+//  ОписаниеТовара - Соответствие Из КлючИЗначение - См.ПолучитьОписаниеТовара
+//  Подборка - Строка - Подборка
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера 
 Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт        
     Возврат УправлениеТоваром(ОписаниеТовара, , Подборка, Параметры);    
 КонецФункции
 
+// Изменить товар.
+// 
+// Параметры:
+//  ИДТовара - Число,Строка - Идентификатор изменяемого товара
+//  ОписаниеТовара - Соответствие Из КлючИЗначение - См.ПолучитьОписаниеТовара
+//  Подборка - Строка - Идентификатор новой подборки
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция ИзменитьТовар(Знач ИДТовара, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт
     Возврат УправлениеТоваром(ОписаниеТовара, ИДТовара, Подборка, Параметры);    
 КонецФункции
 
+// Удалить товар.
+// 
+// Параметры:
+//  Товар - Строка,Число - ID товара
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт
     
     Товар      = OPI_Инструменты.ЧислоВСтроку(Товар);
@@ -870,6 +921,15 @@
     
 КонецФункции
 
+// Сгруппировать товары.
+// 
+// Параметры:
+//  МассивТоваров - Массив Из Строка - Массив ID товаров
+//  СуществующаяГруппа - Строка - ID существующей группы, если необходимо
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт
     
     Параметры_     = ПолучитьСтандартныеПараметры(Параметры);
@@ -893,20 +953,39 @@
 
 КонецФункции
 
+// Получить описание товара.
+// 
+// Возвращаемое значение:
+//  Соответствие Из КлючИЗначение - Пустое описание товара:
+//  *Имя - Строка - Имя товара
+//  *Описание - Строка - Описание товара
+//  *Категория - Строка - См. ПолучитьСписокКатегорийТоваров
+//  *Цена - Число - Цена товара
+//  *СтараяЦена - Число - Для отображения скидки/изменения цены
+//  *ОсновноеФото - Строка,ДвоичныеДанные - Двоичные данные или путь к фото
+//  *URL - Строка - Ссылка на страницу сайта магазина
+//  *ДополнительныеФото - Массив Из Строка - Двоичные данные или пути к фото
+//  *ЗначенияСвойств - Массив Из Строка - См.ДобавитьВариантСвойстваТовара
+//  *ГлавныйВГруппе - Булево - Главный в группе, если есть в группе
+//  *Ширина - Число - Ширина товара в мм.
+//  *Высота - Число - Высота товара в мм.
+//  *Глубина - Число - Глубина товара в мм.
+//  *Вес - Число - Вес в гр.
+//  *SKU - Строка - SKU
+//  *ДоступныйОстаток - Число - Остаток. -1 - не ограничено
 Функция ПолучитьОписаниеТовара() Экспорт
      
     Товар = Новый Соответствие();
     Товар.Вставить("Имя"                , "Новый товар");     // Имя товара
     Товар.Вставить("Описание"           , "Описание товара"); // Описание товара
     Товар.Вставить("Категория"          , "20173");           // См ПолучитьСписокКатегорийТоваров()
-    Товар.Вставить("Цена"               , 1);                 // Цена в руб.
+    Товар.Вставить("Цена"               , 1);                 // Цена.
     Товар.Вставить("СтараяЦена"         , Неопределено);      // Для отражения изменения цены 
     Товар.Вставить("ОсновноеФото"       , Неопределено);      // ДД или путь к осн. фото
     Товар.Вставить("URL"                , Неопределено);      // Ссылка на страницу магазина
     Товар.Вставить("ДополнительныеФото" , Новый Массив);      // Массив путей или ДД для доп. фото
     Товар.Вставить("ЗначенияСвойств"    , Новый Массив);      // Значения свойств (варианты). Максимум 2
-    Товар.Вставить("ГлавныйВГруппе"     , Ложь);              // Сделать главным в своей группе
-    Товар.Вставить("НомерГруппы"        , Неопределено);      
+    Товар.Вставить("ГлавныйВГруппе"     , Ложь);              // Сделать главным в своей группе  
     Товар.Вставить("Ширина"             , Неопределено);      // В миллиметрах
     Товар.Вставить("Высота"             , Неопределено);      // В миллиметрах
     Товар.Вставить("Глубина"            , Неопределено);      // В миллиметрах
@@ -922,6 +1001,13 @@
 
 #Область РаботаСПодборкамиТоваров
 
+// Получить список подборок.
+// 
+// Параметры:
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  Соответствие Из КлючИЗначение - Массив соответствий подборок
 Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -934,6 +1020,14 @@
     
 КонецФункции
 
+// Получить подборки по ИД.
+// 
+// Параметры:
+//  Подборки - Строка, Массив Из Строка - ID подборки(-ок)
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт
     
     Параметры_     = ПолучитьСтандартныеПараметры(Параметры);
@@ -960,6 +1054,17 @@
      
 КонецФункции
 
+// Создать подборку товаров.
+// 
+// Параметры:
+//  Название - Строка - Название подборки
+//  Картинка - Строка,ДвоичныеДанные - Путь или двоичные данные картинки
+//  Основная - Булево - Основная
+//  Скрытая - Булево - Скрытая
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция СоздатьПодборкуТоваров(Знач Название
     , Знач Картинка
     , Знач Основная = Ложь
@@ -970,6 +1075,19 @@
     
 КонецФункции
 
+// Изменить подборку товаров.
+// 
+// Параметры:
+//  Название - Строка - Название подборки
+//  Подборка - Строка - ID подборки
+//  Картинка - Строка,ДвоичныеДанные - Новая картинка подборки
+//  Основная - Булево - Основная
+//  Скрытая - Булево - Скрытая
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера 
+//@skip-check method-too-many-params
 Функция ИзменитьПодборкуТоваров(Знач Название
     , Знач Подборка
     , Знач Картинка = ""
@@ -981,6 +1099,15 @@
     
 КонецФункции
 
+// Добавить товар в подборку.
+// 
+// Параметры:
+//  МассивТовар - Строка, Число - Массив товаров или товар
+//  Подборка - Строка - ID подборки
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+//  ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция ДобавитьТоварВПодборку(Знач МассивТовар, Знач Подборка, Знач Параметры = "") Экспорт
     
     Параметры_   = ПолучитьСтандартныеПараметры(Параметры);
@@ -1010,6 +1137,15 @@
     
 КонецФункции
 
+// Удалить товар из подборки.
+// 
+// Параметры:
+//  Товар - Строка - ID товара
+//  Подборка - Строка - ID подборки
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера
 Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт
     
     Параметры_   = ПолучитьСтандартныеПараметры(Параметры);
@@ -1024,6 +1160,14 @@
     
 КонецФункции
 
+// Удалить подборку.
+// 
+// Параметры:
+//  Подборка - Строка - ID подборки
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера 
 Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт
     
     Подборка   = OPI_Инструменты.ЧислоВСтроку(Подборка);
@@ -1041,6 +1185,13 @@
 
 #Область РаботаСоСвойствамиТоваров
 
+// Получить список свойств.
+// 
+// Параметры:
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера  
 Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1052,6 +1203,14 @@
     
 КонецФункции
 
+// Создать свойство товара.
+// 
+// Параметры:
+//  Название - Строка - Название свойства
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера 
 Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1063,6 +1222,14 @@
 
 КонецФункции
 
+// Удалить свойство товара.
+// 
+// Параметры:
+//  Свойство - Строка,Число - ID свойства
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера  
 Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1074,6 +1241,15 @@
     
 КонецФункции
 
+// Изменить свойство товара.
+// 
+// Параметры:
+//  Название - Строка - Название
+//  Свойство - Строка,Число - ID свойства
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера   
 Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1087,6 +1263,15 @@
 
 КонецФункции
 
+// Добавить вариант свойства товара.
+// 
+// Параметры:
+//  Значение - Строка - Значение свойства
+//  Свойство - Строка,Число - ID свойства, куда добавляется вариант
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера    
 Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1099,6 +1284,16 @@
     
 КонецФункции
 
+// Изменить вариант свойства товара.
+// 
+// Параметры:
+//  Значение - Строка - Новое значение свойства
+//  Свойство - Строка,Число - ID свойства
+//  Вариант - Строка,Число - ID варианта
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера    
 Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1112,6 +1307,14 @@
     
 КонецФункции
 
+// Удалить вариант свойства товара.
+// 
+// Параметры:
+//  Вариант - Строка,Число - ID варианта
+//  Параметры - Структура Из Строка - См.ПолучитьСтандартныеПараметры
+// 
+// Возвращаемое значение:
+// ДвоичныеДанные, Неопределено, Произвольный -  Ответ сервера 
 Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт
     
     Параметры_ = ПолучитьСтандартныеПараметры(Параметры);
@@ -1314,13 +1517,14 @@
     КонецЕсли;
     
     Если ЗначениеЗаполнено(Подборка) Тогда
-        ОтветПодборки = ДобавитьТоварВПодборку(ИДТовара, Подборка, Параметры_);
+        ДобавитьТоварВПодборку(ИДТовара, Подборка, Параметры_);
     КонецЕсли;
     
     Возврат Ответ;
 
 КонецФункции
 
+//@skip-check method-too-many-params
 Функция УправлениеПодборкой(Знач Название
     , Знач Картинка   = ""
     , Знач ИДПодборки = ""
@@ -1342,7 +1546,7 @@
         
         Если ЗначениеЗаполнено(ИДПодборки) Тогда
             
-            Подборки   = OPI_VK.ПолучитьПодборкиПоИД(ИДПодборки, Параметры_);
+            Подборки   = ПолучитьПодборкиПоИД(ИДПодборки, Параметры_);
             Подборки   = Подборки["response"]["items"];
             
             Если Не Подборки.Количество() = 0 Тогда