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

Материал из Umicms
Перейти к:навигация, поиск
Строка 15: Строка 15:
  
  
Когда в следующий раз из 1С опять придет <товар> с <ид> равным "42907251-d287-11de-9943-000fea605ee9", то заново его создавать UMI.CMS не будет, система просто обновит страницу с id = "3242".
+
Когда в следующий раз из 1С опять придет <товар> с <ид> равным "42907251-d287-11de-9943-000fea605ee9", то заново его создавать UMI.CMS не будет, система просто обновит страницу с id = "3242". Пример применения класса можно посмотреть в статье [[Как_переместить_страницу_если_её_раздел_поменялся]].
  
  

Версия 15:02, 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


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

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

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


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

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

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