263 lines
6.8 KiB
PHP
263 lines
6.8 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Platform
|
|
* @subpackage Feed
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
|
*/
|
|
|
|
defined('JPATH_PLATFORM') or die;
|
|
|
|
/**
|
|
* Class to encapsulate a feed entry for the Joomla Platform.
|
|
*
|
|
* @property JFeedPerson $author Person responsible for feed entry content.
|
|
* @property array $categories Categories to which the feed entry belongs.
|
|
* @property string $content The content of the feed entry.
|
|
* @property array $contributors People who contributed to the feed entry content.
|
|
* @property string $copyright Information about rights, e.g. copyrights, held in and over the feed entry.
|
|
* @property array $links Links associated with the feed entry.
|
|
* @property JDate $publishedDate The publication date for the feed entry.
|
|
* @property JFeed $source The feed from which the entry is sourced.
|
|
* @property string $title A human readable title for the feed entry.
|
|
* @property JDate $updatedDate The last time the content of the feed entry changed.
|
|
* @property string $uri Universal, permanent identifier for the feed entry.
|
|
*
|
|
* @package Joomla.Platform
|
|
* @subpackage Feed
|
|
* @since 12.3
|
|
*/
|
|
class JFeedEntry
|
|
{
|
|
/**
|
|
* @var array The entry properties.
|
|
* @since 12.3
|
|
*/
|
|
protected $properties = array(
|
|
'uri' => '',
|
|
'title' => '',
|
|
'updatedDate' => '',
|
|
'content' => '',
|
|
'categories' => array(),
|
|
'contributors' => array(),
|
|
'links' => array()
|
|
);
|
|
|
|
/**
|
|
* Magic method to return values for feed entry properties.
|
|
*
|
|
* @param string $name The name of the property.
|
|
*
|
|
* @return mixed
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function __get($name)
|
|
{
|
|
return (isset($this->properties[$name])) ? $this->properties[$name] : null;
|
|
}
|
|
|
|
/**
|
|
* Magic method to set values for feed properties.
|
|
*
|
|
* @param string $name The name of the property.
|
|
* @param mixed $value The value to set for the property.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function __set($name, $value)
|
|
{
|
|
// Ensure that setting a date always sets a JDate instance.
|
|
if ((($name == 'updatedDate') || ($name == 'publishedDate')) && !($value instanceof JDate))
|
|
{
|
|
$value = new JDate($value);
|
|
}
|
|
|
|
// Validate that any authors that are set are instances of JFeedPerson or null.
|
|
if (($name == 'author') && (!($value instanceof JFeedPerson) || ($value === null)))
|
|
{
|
|
throw new InvalidArgumentException('JFeedEntry "author" must be of type JFeedPerson. ' . gettype($value) . 'given.');
|
|
}
|
|
|
|
// Validate that any sources that are set are instances of JFeed or null.
|
|
if (($name == 'source') && (!($value instanceof JFeed) || ($value === null)))
|
|
{
|
|
throw new InvalidArgumentException('JFeedEntry "source" must be of type JFeed. ' . gettype($value) . 'given.');
|
|
}
|
|
|
|
// Disallow setting categories, contributors, or links directly.
|
|
if (($name == 'categories') || ($name == 'contributors') || ($name == 'links'))
|
|
{
|
|
throw new InvalidArgumentException('Cannot directly set JFeedEntry property "' . $name . '".');
|
|
}
|
|
|
|
$this->properties[$name] = $value;
|
|
}
|
|
|
|
/**
|
|
* Method to add a category to the feed entry object.
|
|
*
|
|
* @param string $name The name of the category to add.
|
|
* @param string $uri The optional URI for the category to add.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function addCategory($name, $uri = '')
|
|
{
|
|
$this->properties['categories'][$name] = $uri;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Method to add a contributor to the feed entry object.
|
|
*
|
|
* @param string $name The full name of the person to add.
|
|
* @param string $email The email address of the person to add.
|
|
* @param string $uri The optional URI for the person to add.
|
|
* @param string $type The optional type of person to add.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function addContributor($name, $email, $uri = null, $type = null)
|
|
{
|
|
$contributor = new JFeedPerson($name, $email, $uri, $type);
|
|
|
|
// If the new contributor already exists then there is nothing to do, so just return.
|
|
foreach ($this->properties['contributors'] as $c)
|
|
{
|
|
if ($c == $contributor)
|
|
{
|
|
return $this;
|
|
}
|
|
}
|
|
|
|
// Add the new contributor.
|
|
$this->properties['contributors'][] = $contributor;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Method to add a link to the feed entry object.
|
|
*
|
|
* @param JFeedLink $link The link object to add.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function addLink(JFeedLink $link)
|
|
{
|
|
// If the new link already exists then there is nothing to do, so just return.
|
|
foreach ($this->properties['links'] as $l)
|
|
{
|
|
if ($l == $link)
|
|
{
|
|
return $this;
|
|
}
|
|
}
|
|
|
|
// Add the new link.
|
|
$this->properties['links'][] = $link;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Method to remove a category from the feed entry object.
|
|
*
|
|
* @param string $name The name of the category to remove.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function removeCategory($name)
|
|
{
|
|
unset($this->properties['categories'][$name]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Method to remove a contributor from the feed entry object.
|
|
*
|
|
* @param JFeedPerson $contributor The person object to remove.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function removeContributor(JFeedPerson $contributor)
|
|
{
|
|
// If the contributor exists remove it.
|
|
foreach ($this->properties['contributors'] as $k => $c)
|
|
{
|
|
if ($c == $contributor)
|
|
{
|
|
unset($this->properties['contributors'][$k]);
|
|
$this->properties['contributors'] = array_values($this->properties['contributors']);
|
|
|
|
return $this;
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Method to remove a link from the feed entry object.
|
|
*
|
|
* @param JFeedLink $link The link object to remove.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function removeLink(JFeedLink $link)
|
|
{
|
|
// If the link exists remove it.
|
|
foreach ($this->properties['links'] as $k => $l)
|
|
{
|
|
if ($l == $link)
|
|
{
|
|
unset($this->properties['links'][$k]);
|
|
$this->properties['links'] = array_values($this->properties['links']);
|
|
|
|
return $this;
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Shortcut method to set the author for the feed entry object.
|
|
*
|
|
* @param string $name The full name of the person to set.
|
|
* @param string $email The email address of the person to set.
|
|
* @param string $uri The optional URI for the person to set.
|
|
* @param string $type The optional type of person to set.
|
|
*
|
|
* @return JFeedEntry
|
|
*
|
|
* @since 12.3
|
|
*/
|
|
public function setAuthor($name, $email, $uri = null, $type = null)
|
|
{
|
|
$author = new JFeedPerson($name, $email, $uri, $type);
|
|
|
|
$this->properties['author'] = $author;
|
|
|
|
return $this;
|
|
}
|
|
}
|