FeedWriter Class Reference
[Feeds]

Basic Feedwriter, extended by IRenderer to fit Gyro style. More...

Inheritance diagram for FeedWriter:

List of all members.

Public Member Functions
	__construct (FeedWriterTitle $title, $items)
	Constructor.
	get_mime_type ()
	Return mime type of feed.
	render ($policy=self::NONE)
	Renders what should be rendered.
Protected Member Functions
	escape ($obj)
	Escape properties.
	relative_to_absolute ($text, $base)
	Helper.
	render_end ($title, $items)
	Render feed closing.
	render_item (FeedWriterItem $item)
	Render an item.
	render_title (FeedWriterTitle $title)
	Render feed title section.
	strip_html ($text)
	Strip off html from.
Protected Attributes
	$items
	$title

---

Detailed Description

Basic Feedwriter, extended by IRenderer to fit Gyro style.

See also:

http://www.gerd-riesselmann.net/archives/2005/05/a-braindead-simple-php-feed-writer-class

Author:

Gerd Riesselmann

Definition at line 109 of file feedwriter.cls.php.

---

Constructor & Destructor Documentation

FeedWriter::__construct	(	FeedWriterTitle $	title,
		$	items
	)

Constructor.

Parameters:

	FeedWriterTitle	$title
	array	$items

Definition at line 122 of file feedwriter.cls.php.

                                                                    {
                $this->items = $items;
                $this->title = $title;
        }

---

Member Function Documentation

FeedWriter::escape

(

$

obj

)

[protected]

Escape properties.

Definition at line 159 of file feedwriter.cls.php.

                                        {
                return String::escape($obj, String::XML);
        }

FeedWriter::get_mime_type

(

)

Return mime type of feed.

Returns:

string

Reimplemented in AtomWriter, and RSSWriter.

Definition at line 132 of file feedwriter.cls.php.

                                        {
                return 'application/xml';
        }

FeedWriter::relative_to_absolute	(	$	text,
		$	base
	)			[protected]

Helper.

Turn relative URLs in text to an absolute one

Parameters:

	string	$text Text containing URLs
	string	$base baseurl

Definition at line 207 of file feedwriter.cls.php.

                                                              {
                if (empty($base)) {
                        return $text;
                }
                        
                if (substr($base, -1, 1) != "/") { $base .= "/"; }
                $domain = Url::create($base)->clear_query()->set_path('')->build(Url::ABSOLUTE);
                
                // Replace href="/abc" with domain
                $pattern =      '|<a(.*?) href="/(.*?)"|';
                $replace = '<a$1 href="' . $domain . '$2"';
                $text = preg_replace($pattern, $replace, $text);
                
                // Replace href="abc" with base
                $pattern =      '|<a(.*?) href="(?!\w+://)(.*?)"|';
                $replace = '<a$1 href="' . $base . '$2"';
                $text = preg_replace($pattern, $replace, $text);

                // Replace src="/abc" with domain
                $pattern =      '|<img(.*?) src="/(.*?)"|';
                $replace = '<img$1 src="' . $domain . '$2"';
                $text = preg_replace($pattern, $replace, $text);
                
                // Replace src="abc" with base
                $pattern =      '|<img(.*?) src="(?!\w+://)(.*?)"|';
                $replace = '<img$1 src="' . $base . '$2"';
                $text = preg_replace($pattern, $replace, $text);
                
                return $text;
        }

FeedWriter::render

(

$

policy = self::NONE

)

Renders what should be rendered.

Parameters:

int

$policy Defines how to render, meaning depends on implementation

Returns:

string The rendered content

Implements IRenderer.

Definition at line 142 of file feedwriter.cls.php.

                                                   {
                $items = '';
                foreach($this->items as $item) {
                        $items .= $this->render_item($item);
                }
                
                // Render title after items, so data collected from items can be used 
                // in title 
                $title = $this->render_title($this->title);

                $ret = $this->render_end($title, $items);               
                return $ret;
        }

FeedWriter::render_end	(	$	title,
		$	items
	)			[protected]

Render feed closing.

Parameters:

	string	$title
	string	$items

Returns:

string

Reimplemented in AtomWriter, and RSSWriter.

Definition at line 190 of file feedwriter.cls.php.

                                                      {
                return '';
        }

FeedWriter::render_item

(

FeedWriterItem $

item

)

[protected]

Render an item.

Parameters:

FeedWriterItem

$item

Returns:

string

Reimplemented in AtomWriter, and RSSWriter.

Definition at line 169 of file feedwriter.cls.php.

                                                             {
                return '';
        }

FeedWriter::render_title

(

FeedWriterTitle $

title

)

[protected]

Render feed title section.

Parameters:

FeedWriterTitle

$title

Returns:

string

Reimplemented in AtomWriter, and RSSWriter.

Definition at line 179 of file feedwriter.cls.php.

                                                                {
                return '';
        }

FeedWriter::strip_html

(

$

text

)

[protected]

Strip off html from.

Definition at line 197 of file feedwriter.cls.php.

                                             {
                return  String::clear_html(String::unescape(str_replace(" ", '', $text)));
        }

---

Member Data Documentation

FeedWriter::$items [protected]

Definition at line 110 of file feedwriter.cls.php.

FeedWriter::$title [protected]

Definition at line 114 of file feedwriter.cls.php.

---

The documentation for this class was generated from the following file:

• contributions/feeds/lib/components/feedwriter/feedwriter.cls.php