Your IP : 216.73.216.81
<?php
declare(strict_types=1);
namespace Laminas\Feed\Reader;
use DOMDocument;
use DOMElement;
use DOMXPath;
// phpcs:ignore SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse
use ReturnTypeWillChange;
use function call_user_func_array;
use function count;
use function in_array;
use function method_exists;
use function strpos;
/**
* @deprecated This (abstract) class is deprecated. Use \Laminas\Feed\Reader\Feed\AbstractFeed instead.]
*
* @template TItem of Entry\AbstractEntry
* @template-implements Feed\FeedInterface<int, TItem>
*/
abstract class AbstractFeed implements Feed\FeedInterface
{
/**
* Parsed feed data
*
* @var array
*/
protected $data = [];
/**
* Parsed feed data in the shape of a DOMDocument
*
* @var DOMDocument
*/
protected $domDocument;
/**
* An array of parsed feed entries
*
* @var array
*/
protected $entries = [];
/**
* A pointer for the iterator to keep track of the entries array
*
* @var int
*/
protected $entriesKey = 0;
/**
* The base XPath query used to retrieve feed data
*
* @var DOMXPath
*/
protected $xpath;
/**
* Array of loaded extensions
*
* @var array
*/
protected $extensions = [];
/**
* Original Source URI (set if imported from a URI)
*
* @var string
*/
protected $originalSourceUri;
/**
* @param DOMDocument $domDocument The DOM object for the feed's XML
* @param null|string $type Feed type
*/
public function __construct(DOMDocument $domDocument, $type = null)
{
$this->domDocument = $domDocument;
$this->xpath = new DOMXPath($this->domDocument);
if ($type !== null) {
$this->data['type'] = $type;
} else {
$this->data['type'] = Reader::detectType($this->domDocument);
}
$this->registerNamespaces();
$this->indexEntries();
$this->loadExtensions();
}
/**
* Set an original source URI for the feed being parsed. This value
* is returned from getFeedLink() method if the feed does not carry
* a self-referencing URI.
*
* @param string $uri
* @return void
*/
public function setOriginalSourceUri($uri)
{
$this->originalSourceUri = $uri;
}
/**
* Get an original source URI for the feed being parsed. Returns null if
* unset or the feed was not imported from a URI.
*
* @return null|string
*/
public function getOriginalSourceUri()
{
return $this->originalSourceUri;
}
/**
* Get the number of feed entries.
* Required by the Iterator interface.
*
* @return int
*/
#[ReturnTypeWillChange]
public function count()
{
return count($this->entries);
}
/**
* Return the current entry
*
* @return Entry\AbstractEntry
*/
#[ReturnTypeWillChange]
public function current()
{
if (0 === strpos($this->getType(), 'rss')) {
$reader = new Entry\Rss($this->entries[$this->key()], $this->key(), $this->getType());
} else {
$reader = new Entry\Atom($this->entries[$this->key()], $this->key(), $this->getType());
}
$reader->setXpath($this->xpath);
return $reader;
}
/**
* Get the DOM
*
* @return DOMDocument
*/
public function getDomDocument()
{
return $this->domDocument;
}
/**
* Get the Feed's encoding
*
* @return string
*/
public function getEncoding()
{
$assumed = $this->getDomDocument()->encoding;
if (empty($assumed)) {
$assumed = 'UTF-8';
}
return $assumed;
}
/**
* Get feed as xml
*
* @return string
*/
public function saveXml()
{
return $this->getDomDocument()->saveXML();
}
/**
* Get the DOMElement representing the items/feed element
*
* @return DOMElement
*/
public function getElement()
{
return $this->getDomDocument()->documentElement;
}
/**
* Get the DOMXPath object for this feed
*
* @return DOMXPath
*/
public function getXpath()
{
return $this->xpath;
}
/**
* Get the feed type
*
* @return string
*/
public function getType()
{
return $this->data['type'];
}
/**
* Return the current feed key
*
* @return int
*/
#[ReturnTypeWillChange]
public function key()
{
return $this->entriesKey;
}
/**
* Move the feed pointer forward
*/
#[ReturnTypeWillChange]
public function next()
{
++$this->entriesKey;
}
/**
* Reset the pointer in the feed object
*/
#[ReturnTypeWillChange]
public function rewind()
{
$this->entriesKey = 0;
}
/**
* Check to see if the iterator is still valid
*
* @return bool
*/
#[ReturnTypeWillChange]
public function valid()
{
return 0 <= $this->entriesKey && $this->entriesKey < $this->count();
}
/** @return array */
public function getExtensions()
{
return $this->extensions;
}
/**
* @param string $method
* @param mixed[] $args
* @return mixed
*/
public function __call($method, $args)
{
foreach ($this->extensions as $extension) {
if (method_exists($extension, $method)) {
return call_user_func_array([$extension, $method], $args);
}
}
throw new Exception\BadMethodCallException(
'Method: ' . $method . ' does not exist and could not be located on a registered Extension'
);
}
/**
* Return an Extension object with the matching name (postfixed with _Feed)
*
* @param string $name
* @return null|Extension\AbstractFeed
*/
public function getExtension($name)
{
$extensionClass = $name . '\\Feed';
return isset($this->extensions[$extensionClass])
&& $this->extensions[$extensionClass] instanceof Extension\AbstractFeed
? $this->extensions[$extensionClass]
: null;
}
protected function loadExtensions()
{
$all = Reader::getExtensions();
$manager = Reader::getExtensionManager();
$feed = $all['feed'];
foreach ($feed as $extension) {
if (in_array($extension, $all['core'])) {
continue;
}
$plugin = $manager->get($extension);
$plugin->setDomDocument($this->getDomDocument());
$plugin->setType($this->data['type']);
$plugin->setXpath($this->xpath);
$this->extensions[$extension] = $plugin;
}
}
/**
* Read all entries to the internal entries array
*/
abstract protected function indexEntries();
/**
* Register the default namespaces for the current feed format
*/
abstract protected function registerNamespaces();
}