Библиотека для cериализации данных в xml

xml-parser

Stars Release Открытый чат проекта https://gitter.im/EvilBeaver/oscript-library

Build Status Coverage Status

Библиотека для cериализации данных в xml

Библиотека предназначена для записи и чтения данных XML для

Установка

Для установки необходимо:

  • Скачать файл *.ospx из раздела releases
  • Воспользоваться командой:
opm install -f <ПутьКФайлу>

или

opm install xml-parser

Особенности работы

Чтение данных из XML

  • При чтении библиотека получает для каждого узла Соответствие со следующими ключами
    • _Атрибуты - соответствие с атрибутами узла
    • _Комментарий - Строка - строка содержащая комментарии узла
    • _CDATA - Строка - строка содержащая данные CDATA узла
    • _Значение - Строка - строка значение узла
    • _Элементы - Массив, Соответствие - вложенные узлы
  • После чтение по умолчанию производится попытка упрощения результата чтения
    • если заполнено только _Значение - тогда присваивается результату чтения узла _Значение
    • если заполнено только _Элементы - тогда присваивается результату чтения узла _Элементы
    • во всех остальных случаях присутствуют только заполненные ключи соответствия

Запись данных в XML

При сериализации данных используются предопределенные ключи:

  • _Атрибуты - соответствие с атрибутами узла
  • _Комментарий - Строка - строка содержащая комментарии узла
  • _CDATA - Строка - строка содержащая данные CDATA узла
  • _Значение - Строка - строка значение узла
  • _Элементы - Массив, Соответствие - вложенные узлы

Пример работы:

  • Чтение данных из файла

    //<ФайлПФР>
    //    <ИмяФайла>
    //        <НазваниеФормата>fb2</НазваниеФормата>
    //        <НазваниеПрограммы />
    //    </ИмяФайла>
    //</ФайлПФР>

    ПутьКФайлу = "ТутНуженПутьКФайлу";

	ПроцессорXML = Новый СериализацияДанныхXML();
	
	РезультатЧтения = ПроцессорXML.ПрочитатьИзФайла(ПутьКФайлу);

    Сообщить(РезультатЧтения["ФайлПФР"]["ИмяФайла"]["НазваниеФормата"]);

  • Запись данных в файл

    ПутьКФайлу = "ТутНуженПутьКФайлу";

	ПроцессорXML = Новый СериализацияДанныхXML();
	ДанныеЗаписиXML = Новый Структура("name", "Наименование");

	ПроцессорXML.ЗаписатьВФайл(ПутьКФайлу);
   
    // Содержимое файла 
    //<name>Наименование</name>

Публичный интерфейс

Документация публичного интерфейса (в разработке)

Доработка

Доработка проводится по git-flow. Жду ваших PR.

Лицензия

Смотри файл LICENSE.

Доступные версии пакета

0.1.1
Изменен: 02.01.2019 19:48:30
0.1.0
Изменен: 02.01.2019 19:48:30
В разработке

Репозиторий

https://github.com/oscript-library/xml-parser

Актуальная версия

xml-parser-0.1.1