PHP Universal Feed Generator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

392 lines
10 KiB

<?php
namespace FeedWriter;
use \DateTime;
use \FeedWriter\View\SyndicationBase;
/*
* Copyright (C) 2008 Anis uddin Ahmad <anisniit@gmail.com>
* Copyright (C) 2010-2013 Michael Bemmerl <mail@mx-server.de>
*
* This file is part of the "Universal Feed Writer" project.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Universal Feed Writer
*
* Item class - Used as feed element in SyndicationBase class
*
* @package UniversalFeedWriter
* @author Anis uddin Ahmad <anisniit@gmail.com>
* @link http://www.ajaxray.com/projects/rss
*/
class Item
{
/**
* Collection of feed item elements
*/
private $elements = array();
/**
* Contains the format of this feed.
*/
private $version;
/**
* Is used as a suffix when multiple elements have the same name.
**/
private $_cpt = 0;
/**
* Constructor
*
* @param constant (RSS1/RSS2/ATOM) RSS2 is default.
*/
function __construct($version = SyndicationBase::RSS2)
{
$this->version = $version;
}
/**
* Return an unique number
* @access private
* @return int
**/
private function cpt() {
return $this->_cpt++;
}
/**
* Add an element to elements array
*
* @access public
* @param string The tag name of an element
* @param string The content of tag
* @param array Attributes(if any) in 'attrName' => 'attrValue' format
* @param boolean Specifies, if an already existing element is overwritten.
* @return void
*/
public function addElement($elementName, $content, $attributes = null, $overwrite = FALSE, $allowMultiple = FALSE)
{
$key = $elementName;
// return if element already exists & if overwriting is disabled
// & if multiple elements are not allowed.
if (isset($this->elements[$elementName]) && !$overwrite) {
if (!$allowMultiple)
return;
$key .= '-' . $this->cpt();
}
$this->elements[$key]['name'] = $elementName;
$this->elements[$key]['content'] = $content;
$this->elements[$key]['attributes'] = $attributes;
return $this;
}
/**
* Set multiple feed elements from an array.
* Elements which have attributes cannot be added by this method
*
* @access public
* @param array array of elements in 'tagName' => 'tagContent' format.
* @return void
*/
public function addElementArray($elementArray)
{
if (!is_array($elementArray))
return;
foreach ($elementArray as $elementName => $content)
{
$this->addElement($elementName, $content);
}
return $this;
}
/**
* Return the collection of elements in this feed item
*
* @access public
* @return array
*/
public function getElements()
{
return $this->elements;
}
/**
* Return the type of this feed item
*
* @access public
* @return string The feed type, as defined in SyndicationBase.php
*/
public function getVersion()
{
return $this->version;
}
// Wrapper functions ------------------------------------------------------
/**
* Set the 'description' element of feed item
*
* @access public
* @param string The content of 'description' or 'summary' element
* @return void
*/
public function setDescription($description)
{
$tag = ($this->version == SyndicationBase::ATOM) ? 'summary' : 'description';
return $this->addElement($tag, $description);
}
/**
* Set the 'content' element of the feed item
* For ATOM feeds only
*
* @access public
* @param string Content for the item (i.e., the body of a blog post).
* @return void
*/
public function setContent($content)
{
if ($this->version != SyndicationBase::ATOM)
throw new Exception('The content element is supported in ATOM feeds only.');
return $this->addElement('content', $content, array('type' => 'html'));
}
/**
* Set the 'title' element of feed item
*
* @access public
* @param string The content of 'title' element
* @return void
*/
public function setTitle($title)
{
return $this->addElement('title', $title);
}
/**
* Set the 'date' element of the feed item.
*
* The value of the date parameter can be either an instance of the
* DateTime class, an integer containing a UNIX timestamp or a string
* which is parseable by PHP's 'strtotime' function.
*
* @access public
* @param DateTime|int|string Date which should be used.
* @return void
*/
public function setDate($date)
{
if(!is_numeric($date))
{
if ($date instanceof DateTime)
$date = $date->getTimestamp();
else
{
$date = strtotime($date);
if ($date === FALSE)
throw new Exception('The given date string was not parseable.');
}
}
else if ($date < 0)
throw new Exception('The given date is not an UNIX timestamp.');
if($this->version == SyndicationBase::ATOM)
{
$tag = 'updated';
$value = date(\DATE_ATOM, $date);
}
elseif($this->version == SyndicationBase::RSS2)
{
$tag = 'pubDate';
$value = date(\DATE_RSS, $date);
}
else
{
$tag = 'dc:date';
$value = date("Y-m-d", $date);
}
return $this->addElement($tag, $value);
}
/**
* Set the 'link' element of feed item
*
* @access public
* @param string The content of 'link' element
* @return void
*/
public function setLink($link)
{
if($this->version == SyndicationBase::RSS2 || $this->version == SyndicationBase::RSS1)
{
$this->addElement('link', $link);
}
else
{
$this->addElement('link','',array('href'=>$link));
$this->addElement('id', SyndicationBase::uuid($link,'urn:uuid:'));
}
return $this;
}
/**
* Attach a external media to the feed item.
* Not supported in RSS 1.0 feeds.
*
* See RFC 4288 for syntactical correct MIME types.
*
* Note that you should avoid the use of more than one enclosure in one item,
* since some RSS aggregators don't support it.
*
* @access public
* @param string The URL of the media.
* @param integer The length of the media.
* @param string The MIME type attribute of the media.
* @param boolean Specifies, if multiple enclosures are allowed
* @return void
* @link https://tools.ietf.org/html/rfc4288
*/
public function addEnclosure($url, $length, $type, $multiple = TRUE)
{
if ($this->version == SyndicationBase::RSS1)
throw new Exception('Media attachment is not supported in RSS1 feeds.');
// the length parameter should be set to 0 if it can't be determined
// see http://www.rssboard.org/rss-profile#element-channel-item-enclosure
if (!is_numeric($length) || $length < 0)
throw new Exception('The length parameter must be an integer and greater or equals to zero.');
// Regex used from RFC 4287, page 41
if (!is_string($type) || preg_match('/.+\/.+/', $type) != 1)
throw new Exception('type parameter must be a string and a MIME type.');
$attributes = array('length' => $length, 'type' => $type);
if ($this->version == SyndicationBase::RSS2)
{
$attributes['url'] = $url;
$this->addElement('enclosure', '', $attributes, FALSE, $multiple);
}
else
{
$attributes['href'] = $url;
$attributes['rel'] = 'enclosure';
$this->addElement('atom:link', '', $attributes, FALSE, $multiple);
}
return $this;
}
/**
* Alias of addEnclosure, for backward compatibility. Using only this
* method ensure that the 'enclosure' element will be present only once.
*
* @access public
* @param string The URL of the media.
* @param integer The length of the media.
* @param string The MIME type attribute of the media.
* @return void
* @link https://tools.ietf.org/html/rfc4288
*
**/
public function setEnclosure($url, $length, $type) {
return $this->addEnclosure($url, $length, $type, false);
}
/**
* Set the 'author' element of feed item.
* Not supported in RSS 1.0 feeds.
*
* @access public
* @param string The author of this item
* @param string Optional email address of the author
* @param string Optional URI related to the author
* @return void
*/
public function setAuthor($author, $email = null, $uri = null)
{
switch($this->version)
{
case SyndicationBase::RSS1: throw new Exception('The author element is not supported in RSS1 feeds.');
break;
case SyndicationBase::RSS2:
if ($email != null)
$author = $email . ' (' . $author . ')';
$this->addElement('author', $author);
break;
case SyndicationBase::ATOM:
$elements = array('name' => $author);
// Regex from RFC 4287 page 41
if ($email != null && preg_match('/.+@.+/', $email) == 1)
$elements['email'] = $email;
if ($uri != null)
$elements['uri'] = $uri;
$this->addElement('author', $elements);
break;
}
return $this;
}
/**
* Set the unique identifier of the feed item
*
* @access public
* @param string The unique identifier of this item
* @param boolean The value of the 'isPermaLink' attribute in RSS 2 feeds.
* @return void
*/
public function setId($id, $permaLink = false)
{
if ($this->version == SyndicationBase::RSS2)
{
if (!is_bool($permaLink))
throw new Exception('The permaLink parameter must be boolean.');
$permaLink = $permaLink ? 'true' : 'false';
$this->addElement('guid', $id, array('isPermaLink' => $permaLink));
}
else if ($this->version == SyndicationBase::ATOM)
{
$this->addElement('id', SyndicationBase::uuid($id,'urn:uuid:'), NULL, TRUE);
}
else
throw new Exception('A unique ID is not supported in RSS1 feeds.');
return $this;
}
} // end of class Item