Главная / Zend Manual Core
Введение
Zend_Feed
Programmer's Reference Guide

Импортирование лент с помощью Zend_Feed

Zend_Feed позволяет легко получать ленты. Если вам известен URI ленты, то просто используйте метод Zend_Feed::import():

  1. $feed = Zend_Feed::import('http://feeds.example.com/feedName');

Еще вы можете использовать Zend_Feed для извлечения содержимого ленты из файла или строки:

  1. // импортирование ленты из текстового файла
  2. $feedFromFile = Zend_Feed::importFile('feed.xml');
  3.  
  4. // импортирование ленты из строки
  5. $feedFromPHP = Zend_Feed::importString($feedString);

В примерах выше в случае успеха возвращается объект одного из классов, расширяющих Zend_Feed_Abstract, в зависимости от типа ленты. Если посредством одного из вышеприведенных методов для импортирования была извлечена лента RSS, то будет возвращен объект Zend_Feed_Rss. Если же импортируется лента Atom, то будет возвращен объект Zend_Feed_Atom. Эти методы для импортирования будут бросать исключение Zend_Feed_Exception в случае ошибки, такой, как недоступная для чтения или плохо сформированная лента.

Создание собственных лент

Zend_Feed позволяет разработчикам легко создавать собственные ленты. Вам нужно просто создать массив и импортировать его в Zend_Feed. Импорт из массива может быть выполнен с помощью методов Zend_Feed::importArray() или Zend_Feed::importBuilder(). В последнем методе массив будет сформирован на лету с помощью специального источника данных, реализующего интерфейс Zend_Feed_Builder_Interface.

Импортирование массива

  1. // Импортирование ленты из массива
  2. $atomFeedFromArray = Zend_Feed::importArray($array);
  3.  
  4. // Следующая строка эквивалентна предыдущей
  5. // По умолчанию возвращается экземпляр Zend_Feed_Atom
  6. $atomFeedFromArray = Zend_Feed::importArray($array, 'atom');
  7.  
  8. // Импортирование ленты RSS из массива
  9. $rssFeedFromArray = Zend_Feed::importArray($array, 'rss');

Формат массива должен соответствовать следующей структуре:

  2.       'title'       => 'заголовок ленты', // обязательный
  3.       'link'        => 'канонический URL ленты', // обязательный
  4.       'lastUpdate'  => 'время обновления', // опциональный
  5.       'published'   => 'время публикации', // опциональный
  6.       'charset'     => 'кодировка для текстовых данных', // обязательный
  7.       'description' => 'краткое описание ленты', // опциональный
  8.       'author'      => 'автор/издатель ленты', // опциональный
  9.       'email'       => 'e-mail автора', // опциональный
  10.       'webmaster'   =>     // опциональный, игнорируется, если используется Atom
  11.                        'e-mail лица, отвечающего за технические вопросы'
  12.       'copyright'   => 'авторские права', // опциональный
  13.       'image'       => 'URL к изображению', // опциональный
  14.       'generator'   => 'генератор', // опциональный
  15.       'language'    => 'язык, на котором выпускается лента', // опциональный
  16.       'ttl'         =>     // опциональный, игнорируется, если используется Atom
  17.                        'сколько минут лента может храниться в кэше ' .
  18.                        'до обновления',
  19.       'rating'      =>     // опциональный, игнорируется, если используется Atom
  20.                        'рейтинг PICS',
  21.       'cloud'       => array(
  22.                              'domain'            => 'домен, пример: rpc.sys.com', // обязательный
  23.                              'port'              => 'порт', // опциональный, по умолчанию 80
  24.                              'path'              => 'путь, пример: /RPC2', // обязательный
  25.                              'registerProcedure' => 'процедура для вызова, пример: myCloud.rssPleaseNotify', // обязательный
  26.                              'protocol'          => 'используемый протокол, например, soap или xml-rpc' // обязательный
  27.                              ), // веб-сервис, поддерживающий интерфейс
  28.                                 // rssCloud, отвечающий за уведомления об изменениях в канале
  29.                                 // опциональный, игнорируется, если используется Atom
  30.       'textInput'   => array(
  31.                              'title'       => 'надпись для кнопки отправки', // обязательный
  32.                              'description' => 'пояснение к текстовому полю', // обязательный
  33.                              'name'        => 'атрибут name для текстового поля', // обязательный
  34.                              'link'        => 'URL скрипта, которому будет отправлены данные' // обязательный
  35.                              ), // текстовое поле для ввода, которое может отображаться в ленте
  36.                                 // опциональный, игнорируется, если используется Atom
  37.       'skipHours'   => array(
  38.                              'часы в формате 24'
  39.                              // может содержать до 24 элементов, значения которых должны
  40.                              // находиться в диапазоне 0..23
  41.                              ), // Указывает аггрегатору, в какие часы он может не обновлять канал
  42.                                 // опциональный, игнорируется, если используется Atom
  43.       'skipDays '   => array(
  44.                              'пропускаемые дни недели'
  45.                              // может содержать до 7 элементов, значениями которых должны быть
  46.                              // Monday, Tuesday, Wednesday, Thursday, Friday, Saturday или Sunday
  47.                              ), // Указывает аггрегатору, в какие дни недели он может не обновлять канал
  48.                                 // опциональный, игнорируется, если используется Atom
  49.       'itunes'      => array(
  50.                              'author'       => 'автор', // опциональный, по умолчанию используется элемент из channel
  51.                              'owner'        => array(
  52.                                                      'name' => 'имя владельца', // опциональный, по умолчанию используется элемент из channel
  53.                                                      'email' => 'e-mail владельца' // опциональный, по умолчанию используется элемент из channel
  54.                                                      ) // владелец подкаста // опциональный
  55.                              'image'        => 'изображение для альбома/подкаста', // опциональный, по умолчанию используется элемент из channel
  56.                              'subtitle'     => 'краткое описание', // опциональный, по умолчанию используется элемент из channel
  57.                              'summary'      => 'полное описание', // опциональный, по умолчанию используется элемент из channel
  58.                              'block'        => 'блокирует показ (yes|no)', // опциональный
  59.                              'category'     => array(
  60.                                                      array('main' => 'основная категория', // обязательный
  61.                                                            'sub'  => 'подкатегория' // опциональный
  62.                                                            ),
  63.                                                      // до 3-х элементов с парами категория/подкатегория
  64.                                                      ) // 'категории для навигации' // обязательный
  65.                              'explicit'     => 'индикатор наличия материалов откровенного содержания (yes|no|clean)', // опциональный
  66.                              'keywords'     => 'список из ключевых слов, разделенных запятой (до 12 слов)', // опциональный
  67.                              'new-feed-url' => 'используется для того, чтобы сообщить iTunes о новом URL ленты' // опциональный
  68.                              ) // данные для iTunes // опциональный, игнорируется, если используется Atom
  69.       'entries'     => array(
  70.                              array(
  71.                                    'title'        => 'заголовок сообщения', // обязательный
  72.                                    'link'         => 'URL сообщения', // обязательный
  73.                                    'description'  => 'краткое описание', // только текст без HTML, обязательный
  74.                                    'guid'         => 'идентификатор сообщения, если не передан, то используется URL сообщения', // опциональный
  75.                                    'content'      => 'содержание сообщения', // может содержать HTML, опциональный
  76.                                    'lastUpdate'   => 'дата публикации', // опциональный
  77.                                    'comments'     => 'страница для комментариев к сообщению', // опциональный
  78.                                    'commentRss'   => 'URL ленты для комментариев, относящихся к сообщению', // опциональный
  79.                                    'source'       => array(
  80.                                                            'title' => 'заголовок оригинального источника', // обязательный
  81.                                                            'url' => 'URL оригинального источника', // обязательный
  82.                                                            ), // оригинальный источник сообщения // опциональный
  83.                                    'category'     => array(
  84.                                                            array(
  85.                                                                  'term' => 'имя категории', // обязательный
  86.                                                                  'scheme' => 'URL ресурса с классификацией' // опциональный
  87.                                                                  ),
  88.                                                            array(
  89.                                                                  // данные второй категории и т.д.
  90.                                                                  )
  91.                                                            ), // список прикрепленных категорий // опциональный
  92.                                    'enclosure'    => array(
  93.                                                            array(
  94.                                                                  'url' => 'URL вложения', // обязательный
  95.                                                                  'type' => 'тип MIME вложения', // опциональный
  96.                                                                  'length' => 'размер вложения в октетах' // опциональный
  97.                                                                  ),
  98.                                                            array(
  99.                                                                  // данные для второго вложения и т.д.
  100.                                                                  )
  101.                                                            ) // список вложений для сообщения // опциональный
  102.                                    ),
  103.                              array(
  104.                                    // данные второго сообщения и т.д.
  105.                                    )
  106.                              )
  107.        );

Информационные ресурсы:

Импортирование из специального источника данных

Вы можете создать экземпляр Zeed_Feed из любого источника данных, реализующего интерфейс Zend_Feed_Builder_Interface. Вам нужно только реализовать методы getHeader() и getEntries() для того, чтобы можно было использовать свой объект с Zend_Feed::importBuilder(). Простой пример - вы можете использовать компоновщик Zend_Feed_Builder, который принимает массив в своем конструкторе, выполняет некоторую проверку и затем может использоваться в методе importBuilder(). getEntries() должен возвращать массив экземпляров Zend_Feed_Builder_Entry.

Note: Zend_Feed_Builder служит только в качестве конкретной реализации для демонстрации использования. Пользователи должны создавать свои классы, реализующие интерфейс Zend_Feed_Builder_Interface.

Ниже приведен пример использования Zend_Feed::importBuilder():

  1. // Импортирование ленты из специального созданного ресурса-компоновщика
  2. $atomFeedFromArray =
  3.     Zend_Feed::importBuilder(new Zend_Feed_Builder($array));
  4.  
  5. // Следующая строка эквивалентна предыдущей.
  6. // По умолчанию возвращается экземпляр Zend_Feed_Atom
  7. $atomFeedFromArray =
  8.     Zend_Feed::importArray(new Zend_Feed_Builder($array), 'atom');
  9.  
  10. // Импортирование RSS-ленты из специально созданного ресурса-компоновщика
  11. $rssFeedFromArray =
  12.     Zend_Feed::importArray(new Zend_Feed_Builder($array), 'rss');

Дапм содержимого ленты

Для того, чтобы произвести дамп экземпляра Zend_Feed_Abstract, вы можете использовать методы send() или saveXml().

  1. assert($feed instanceof Zend_Feed_Abstract);
  2.  
  3. // вывод дампа ленты
  4. print $feed->saveXML();
  5.  
  6. // отправка HTTP-заголовков и вывод дампа ленты
  7. $feed->send();
Введение
Zend_Feed
Programmer's Reference Guide