You've already forked joomla_test
first commit
This commit is contained in:
alazhar
330
libraries/joomla/feed/feed.php
Normal file
330
libraries/joomla/feed/feed.php
Normal file
@ -0,0 +1,330 @@
|
||||
<?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 for the Joomla Platform.
|
||||
*
|
||||
* @property JFeedPerson $author Person responsible for feed content.
|
||||
* @property array $categories Categories to which the feed belongs.
|
||||
* @property array $contributors People who contributed to the feed content.
|
||||
* @property string $copyright Information about rights, e.g. copyrights, held in and over the feed.
|
||||
* @property string $description A phrase or sentence describing the feed.
|
||||
* @property string $generator A string indicating the program used to generate the feed.
|
||||
* @property string $image Specifies a GIF, JPEG or PNG image that should be displayed with the feed.
|
||||
* @property JDate $publishedDate The publication date for the feed content.
|
||||
* @property string $title A human readable title for the feed.
|
||||
* @property JDate $updatedDate The last time the content of the feed changed.
|
||||
* @property string $uri Universal, permanent identifier for the feed.
|
||||
*
|
||||
* @package Joomla.Platform
|
||||
* @subpackage Feed
|
||||
* @since 12.3
|
||||
*/
|
||||
class JFeed implements ArrayAccess
|
||||
{
|
||||
/**
|
||||
* @var array The entry properties.
|
||||
* @since 12.3
|
||||
*/
|
||||
protected $properties = array(
|
||||
'uri' => '',
|
||||
'title' => '',
|
||||
'updatedDate' => '',
|
||||
'description' => '',
|
||||
'categories' => array(),
|
||||
'contributors' => array()
|
||||
);
|
||||
|
||||
/**
|
||||
* @var array The list of feed entry objects.
|
||||
* @since 12.3
|
||||
*/
|
||||
protected $entries = array();
|
||||
|
||||
/**
|
||||
* Magic method to return values for feed 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('JFeed "author" must be of type JFeedPerson. ' . gettype($value) . 'given.');
|
||||
}
|
||||
|
||||
// Disallow setting categories or contributors directly.
|
||||
if (($name == 'categories') || ($name == 'contributors'))
|
||||
{
|
||||
throw new InvalidArgumentException('Cannot directly set JFeed property "' . $name . '".');
|
||||
}
|
||||
|
||||
$this->properties[$name] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to add a category to the feed object.
|
||||
*
|
||||
* @param string $name The name of the category to add.
|
||||
* @param string $uri The optional URI for the category to add.
|
||||
*
|
||||
* @return JFeed
|
||||
*
|
||||
* @since 12.3
|
||||
*/
|
||||
public function addCategory($name, $uri = '')
|
||||
{
|
||||
$this->properties['categories'][$name] = $uri;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to add a contributor to the feed 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 JFeed
|
||||
*
|
||||
* @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 an entry to the feed object.
|
||||
*
|
||||
* @param JFeedEntry $entry The entry object to add.
|
||||
*
|
||||
* @return JFeed
|
||||
*
|
||||
* @since 12.3
|
||||
*/
|
||||
public function addEntry(JFeedEntry $entry)
|
||||
{
|
||||
// If the new entry already exists then there is nothing to do, so just return.
|
||||
foreach ($this->entries as $e)
|
||||
{
|
||||
if ($e == $entry)
|
||||
{
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
|
||||
// Add the new entry.
|
||||
$this->entries[] = $entry;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not an offset exists. This method is executed when using isset() or empty() on
|
||||
* objects implementing ArrayAccess.
|
||||
*
|
||||
* @param mixed $offset An offset to check for.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @see ArrayAccess::offsetExists()
|
||||
* @since 12.3
|
||||
*/
|
||||
public function offsetExists($offset)
|
||||
{
|
||||
return isset($this->entries[$offset]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the value at specified offset.
|
||||
*
|
||||
* @param mixed $offset The offset to retrieve.
|
||||
*
|
||||
* @return mixed The value at the offset.
|
||||
*
|
||||
* @see ArrayAccess::offsetGet()
|
||||
* @since 12.3
|
||||
*/
|
||||
public function offsetGet($offset)
|
||||
{
|
||||
return $this->entries[$offset];
|
||||
}
|
||||
|
||||
/**
|
||||
* Assigns a value to the specified offset.
|
||||
*
|
||||
* @param mixed $offset The offset to assign the value to.
|
||||
* @param JFeedEntry $value The JFeedEntry to set.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @see ArrayAccess::offsetSet()
|
||||
* @since 12.3
|
||||
*/
|
||||
public function offsetSet($offset, $value)
|
||||
{
|
||||
if (!($value instanceof JFeedEntry))
|
||||
{
|
||||
throw new InvalidArgumentException('Cannot set value of type "' . gettype($value) . '".');
|
||||
}
|
||||
|
||||
$this->entries[$offset] = $value;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unsets an offset.
|
||||
*
|
||||
* @param mixed $offset The offset to unset.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @see ArrayAccess::offsetUnset()
|
||||
* @since 12.3
|
||||
*/
|
||||
public function offsetUnset($offset)
|
||||
{
|
||||
unset($this->entries[$offset]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to remove a category from the feed object.
|
||||
*
|
||||
* @param string $name The name of the category to remove.
|
||||
*
|
||||
* @return JFeed
|
||||
*
|
||||
* @since 12.3
|
||||
*/
|
||||
public function removeCategory($name)
|
||||
{
|
||||
unset($this->properties['categories'][$name]);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to remove a contributor from the feed object.
|
||||
*
|
||||
* @param JFeedPerson $contributor The person object to remove.
|
||||
*
|
||||
* @return JFeed
|
||||
*
|
||||
* @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 an entry from the feed object.
|
||||
*
|
||||
* @param JFeedEntry $entry The entry object to remove.
|
||||
*
|
||||
* @return JFeed
|
||||
*
|
||||
* @since 12.3
|
||||
*/
|
||||
public function removeEntry(JFeedEntry $entry)
|
||||
{
|
||||
// If the entry exists remove it.
|
||||
foreach ($this->entries as $k => $e)
|
||||
{
|
||||
if ($e == $entry)
|
||||
{
|
||||
unset($this->entries[$k]);
|
||||
$this->entries = array_values($this->entries);
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Shortcut method to set the author for the feed 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 JFeed
|
||||
*
|
||||
* @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;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user