Класс umiImportRelations — различия между версиями

Материал из Umicms
Перейти к:навигация, поиск
Строка 29: Строка 29:
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">getSourceId()</span> - Получить идентификатор ресурса (Каждому сценарию импорта/экспорта в таблице cms3_import_sources соответствует свой ресурс)
+
   <li><span style="color:blue">getSourceId()</span> - Получить идентификатор ресурса (Каждому сценарию импорта в таблице cms3_import_sources соответствует свой ресурс)
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     String<span style="color:blue"> $source_name</span>:
 
     String<span style="color:blue"> $source_name</span>:
Строка 47: Строка 47:
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">setIdRelation()</span> - Добавить связь импортируемой сущностью/страницей в UMI.CMS и страницей в UMI.CMS/экспортируемой сущностью в файле экспорта.
+
   <li><span style="color:blue">setIdRelation()</span> - Добавить связь между импортируемой сущностью и созданной страницей в UMI.CMS.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>
 
     Идентификатор ресурса<br/>
 
     String <span style="color:blue">$old_id</span>:
 
     String <span style="color:blue">$old_id</span>:
−
     Идентификатор импортируемой сущности/страницы в UMI.CMS<br/>
+
     Идентификатор импортируемой сущности<br/>
 
     String <span style="color:blue">$new_id</span>:
 
     String <span style="color:blue">$new_id</span>:
−
     Идентификатор страницы в UMI.CMS/экспортируемой сущности<br/>
+
     Идентификатор страницы в UMI.CMS<br/>
 
     </p>
 
     </p>
 
     <p>'''Результат:''' true, в случае успеха, false в случае неудачи</p>
 
     <p>'''Результат:''' true, в случае успеха, false в случае неудачи</p>
Строка 60: Строка 60:
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">getNewIdRelation()</span> - Получить новое значение (new_id) из таблицы cms3_import_relations.
+
   <li><span style="color:blue">getNewIdRelation()</span> - Получить id страницы в UMI.CMS, соответствующий импортируемой сущности.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>
 
     Идентификатор ресурса<br/>
 
     String <span style="color:blue">$old_id</span>:
 
     String <span style="color:blue">$old_id</span>:
−
     Идентификатор импортируемой сущности/страницы в UMI.CMS<br/></p>
+
     Идентификатор импортируемой сущности<br/></p>
−
     <p>'''Результат:''' "новый" идентификатор(new_id), false в случае неудачи</p>
+
     <p>'''Результат:''' идентификатор страницы в UMI.CMS, false в случае неудачи</p>
 
     <hr>
 
     <hr>
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">getOldIdRelation()</span> - Получить старое значение (old_id) из таблицы cms3_import_relations.
+
   <li><span style="color:blue">getOldIdRelation()</span> - Получить идентификатор импортируемой сущности, соответствующий странице в UMI.CMS.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>
 
     Идентификатор ресурса<br/>
 
     String <span style="color:blue">$new_id</span>:
 
     String <span style="color:blue">$new_id</span>:
−
     Идентификатор страницы в UMI.CMS/экспортируемой сущности<br/></p>
+
     Идентификатор страницы в UMI.CMS<br/></p>
−
     <p>'''Результат:''' "старый" идентификатор(old_id), false в случае неудачи</p>
+
     <p>'''Результат:''' идентификатор импортируемой сущности, false в случае неудачи</p>
 
     <hr>
 
     <hr>
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">setTypeIdRelation()</span> - Добавить связь между импортируемым/экспортируемым и созданным/имеющимся типом данных в таблицу cms3_import_types.
+
   <li><span style="color:blue">setTypeIdRelation()</span> - Добавить связь между импортируемым типом данных и созданным/имеющимся в UMI.CMS.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>
 
     Идентификатор ресурса<br/>
 
     String <span style="color:blue">$old_id</span>:
 
     String <span style="color:blue">$old_id</span>:
−
     Идентификатор импортируемого типа/имеющегося типа в UMI.CMS<br/>
+
     Идентификатор импортируемого типа данных<br/>
 
     String <span style="color:blue">$new_id</span>:
 
     String <span style="color:blue">$new_id</span>:
−
     Идентификатор созданного/экспортируемого типа<br/>
+
     Идентификатор созданного/имеющегося типа<br/>
 
     </p>
 
     </p>
 
     <p>'''Результат:''' true, в случае успеха, false в случае неудачи</p>
 
     <p>'''Результат:''' true, в случае успеха, false в случае неудачи</p>
Строка 93: Строка 93:
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">getNewTypeIdRelation()</span> - Получить новое значение (new_id) из таблицы cms3_import_types.
+
   <li><span style="color:blue">getNewTypeIdRelation()</span> - Получить идентификатор созданного типа данных в UMI.CMS, соответствующего импортируемому.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>
 
     Идентификатор ресурса<br/>
 
     String <span style="color:blue">$old_id</span>:
 
     String <span style="color:blue">$old_id</span>:
−
     Идентификатор созданного/экспортируемого типа<br/></p>
+
     Идентификатор импортируемого типа<br/></p>
−
     <p>'''Результат:''' "новый" идентификатор(new_id), false в случае неудачи</p>
+
     <p>'''Результат:''' идентификатор созданного типа, false в случае неудачи</p>
 
     <hr>
 
     <hr>
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">getOldTypeIdRelation()</span> - Получить старое значение (old_id) из таблицы cms3_import_types.
+
   <li><span style="color:blue">getOldTypeIdRelation()</span> - Получить идентификатор импортируемого типа, соответствующего созданному.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>
 
     Идентификатор ресурса<br/>
 
     String <span style="color:blue">$new_id</span>:
 
     String <span style="color:blue">$new_id</span>:
−
     Идентификатор импортируемого типа/имеющегося типа в UMI.CMS<br/></p>
+
     Идентификатор созданного типа в UMI.CMS<br/></p>
−
     <p>'''Результат:''' "старый" идентификатор(old_id), false в случае неудачи</p>
+
     <p>'''Результат:''' идентификатор импортируемого типа, false в случае неудачи</p>
 
     <hr>
 
     <hr>
 
   </li>
 
   </li>
  
−
   <li><span style="color:blue">setFieldIdRelation()</span> - Добавить новую связь между полями в cms3_import_fields.
+
   <li><span style="color:blue">setFieldIdRelation()</span> - Добавить между импортируемым и созданным полем.
 
     <p>'''Параметры:''' <br/>  
 
     <p>'''Параметры:''' <br/>  
 
     Int <span style="color:blue">$source_id</span>:
 
     Int <span style="color:blue">$source_id</span>:
 
     Идентификатор ресурса<br/>  
 
     Идентификатор ресурса<br/>  
 
     String <span style="color:blue">$type_id</span>:
 
     String <span style="color:blue">$type_id</span>:
−
     "Новый" идентификатор импортированного типа данных<br/>  
+
     Идентификатор созданного типа данных<br/>  
 
     String <span style="color:blue">$old_field_name</span>:
 
     String <span style="color:blue">$old_field_name</span>:
 
     Имя импортируемого поля<br/>  
 
     Имя импортируемого поля<br/>  

Версия 14:54, 7 апреля 2014

Описание класса: Класс служит для работы со связями между импортируемыми сущностями и системными объектами.

Например, из 1С к нам приходит <товар> с <ид> равным "42907251-d287-11de-9943-000fea605ee9", UMI.CMS создает <page> с идентификатором id = "3242", и записывает в таблицу cms3_import_relations следующую запись:


source_idold_idnew_id
12342907251-d287-11de-9943-000fea605ee93242


Когда в следующий раз из 1С опять придет <товар> с <ид> равным "42907251-d287-11de-9943-000fea605ee9", то заново его создавать UMI.CMS не будет, система просто обновит страницу с id = "3242".


Класс является синглтоном, экземпляр класса можно получить через статический метод getInstance(). Исходный код класса находится в файле /classes/system/utils/importRelations/umiImportRelations.php.


Описание методов класса umiImportRelations:

  • getInstance() - Получить экземпляр коллекции

    Параметры:

    Результат: экземпляр класса umiImportRelations

  • getSourceId() - Получить идентификатор ресурса (Каждому сценарию импорта в таблице cms3_import_sources соответствует свой ресурс)

    Параметры:
    String $source_name: Имя ресурса

    Например, commerceML2 или имя csv файла, или идентификатор ресурса, указанный в сценарии импорта.

    Результат: массив идентификаторов ресурсов

  • addNewSource() - Добавить ресурс.

    Параметры:
    String $source_name: Имя ресурса

    Результат: Если ресурс с таким $source_name существует, то будет возвращен его id. Если ресурса с таким $source_name нет, то ресурс будет создан и метод вернет его id.

  • setIdRelation() - Добавить связь между импортируемой сущностью и созданной страницей в UMI.CMS.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $old_id: Идентификатор импортируемой сущности
    String $new_id: Идентификатор страницы в UMI.CMS

    Результат: true, в случае успеха, false в случае неудачи

  • getNewIdRelation() - Получить id страницы в UMI.CMS, соответствующий импортируемой сущности.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $old_id: Идентификатор импортируемой сущности

    Результат: идентификатор страницы в UMI.CMS, false в случае неудачи

  • getOldIdRelation() - Получить идентификатор импортируемой сущности, соответствующий странице в UMI.CMS.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $new_id: Идентификатор страницы в UMI.CMS

    Результат: идентификатор импортируемой сущности, false в случае неудачи

  • setTypeIdRelation() - Добавить связь между импортируемым типом данных и созданным/имеющимся в UMI.CMS.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $old_id: Идентификатор импортируемого типа данных
    String $new_id: Идентификатор созданного/имеющегося типа

    Результат: true, в случае успеха, false в случае неудачи

  • getNewTypeIdRelation() - Получить идентификатор созданного типа данных в UMI.CMS, соответствующего импортируемому.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $old_id: Идентификатор импортируемого типа

    Результат: идентификатор созданного типа, false в случае неудачи

  • getOldTypeIdRelation() - Получить идентификатор импортируемого типа, соответствующего созданному.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $new_id: Идентификатор созданного типа в UMI.CMS

    Результат: идентификатор импортируемого типа, false в случае неудачи

  • setFieldIdRelation() - Добавить между импортируемым и созданным полем.

    Параметры:
    Int $source_id: Идентификатор ресурса
    String $type_id: Идентификатор созданного типа данных
    String $old_field_name: Имя импортируемого поля
    Int $new_field_id: id поля в UMI.CMS

    Результат: Возвращает id поля в UMI.CMS

Источник — «https://wiki.umisoft.ru/index.php?title=Класс_umiImportRelations&oldid=7374»