blob: 29ac8bb22ed28d832ced64fed4864df0e15a2936 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
<?php
/**
* TFeedService and TFeed class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Knut Urdalen <knut.urdalen@gmail.com>
* @link http://www.pradosoft.com
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id$
* @package Prado\Web\Services
*/
namespace Prado\Web\Services;
/**
* IFeedContentProvider interface.
*
* IFeedContentProvider interface must be implemented by a feed class who
* provides feed content.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Knut Urdalen <knut.urdalen@gmail.com>
* @package Prado\Web\Services
* @since 3.1
*/
interface IFeedContentProvider
{
/**
* Initializes the feed content provider.
* This method is invoked (before {@link getFeedContent})
* when the feed provider is requested by a user.
* @param TXmlElement configurations specified within the <feed> element
* corresponding to this feed provider when configuring {@link TFeedService}.
*/
public function init($config);
/**
* @return string feed content in proper XML format
*/
public function getFeedContent();
/**
* Sets the content type of the feed content to be sent.
* Some examples are:
* RSS 1.0 feed: application/rdf+xml
* RSS 2.0 feed: application/rss+xml or application/xml or text/xml
* ATOM feed: application/atom+xml
* @return string the content type for the feed content.
* @since 3.1.1
*/
public function getContentType();
}
|