* @todo Also, |atom:link|@rel=self
* @param bool $permanent Permanent mode to return only the original URL or the first redirection
* iff it is a 301 redirection
* @return string|null
*/
public function subscribe_url($permanent = false)
{
if ($permanent) {
if ($this->permanent_url !== null) {
// sanitize encodes ampersands which are required when used in a url.
return str_replace(
'&',
'&',
$this->sanitize(
$this->permanent_url,
self::CONSTRUCT_IRI
)
);
}
} else {
if ($this->feed_url !== null) {
return str_replace(
'&',
'&',
$this->sanitize(
$this->feed_url,
self::CONSTRUCT_IRI
)
);
}
}
return null;
}
/**
* Get data for an feed-level element
*
* This method allows you to get access to ANY element/attribute that is a
* sub-element of the opening feed tag.
*
* The return value is an indexed array of elements matching the given
* namespace and tag name. Each element has `attribs`, `data` and `child`
* subkeys. For `attribs` and `child`, these contain namespace subkeys.
* `attribs` then has one level of associative name => value data (where
* `value` is a string) after the namespace. `child` has tag-indexed keys
* after the namespace, each member of which is an indexed array matching
* this same format.
*
* For example:
*
* // This is probably a bad example because we already support
* // natively, but it shows you how to parse through
* // the nodes.
* $group = $item->get_item_tags(\SimplePie\SimplePie::NAMESPACE_MEDIARSS, 'group');
* $content = $group[0]['child'][\SimplePie\SimplePie::NAMESPACE_MEDIARSS]['content'];
* $file = $content[0]['attribs']['']['url'];
* echo $file;
*
*
* @since 1.0
* @see http://simplepie.org/wiki/faq/supported_xml_namespaces
* @param string $namespace The URL of the XML namespace of the elements you're trying to access
* @param string $tag Tag name
* @return array
*/
public function get_feed_tags($namespace, $tag)
{
$type = $this->get_type();
if ($type & self::TYPE_ATOM_10) {
if (isset($this->data['child'][self::NAMESPACE_ATOM_10]['feed'][0]['child'][$namespace][$tag])) {
return $this->data['child'][self::NAMESPACE_ATOM_10]['feed'][0]['child'][$namespace][$tag];
}
}
if ($type & self::TYPE_ATOM_03) {
if (isset($this->data['child'][self::NAMESPACE_ATOM_03]['feed'][0]['child'][$namespace][$tag])) {
return $this->data['child'][self::NAMESPACE_ATOM_03]['feed'][0]['child'][$namespace][$tag];
}
}
if ($type & self::TYPE_RSS_RDF) {
if (isset($this->data['child'][self::NAMESPACE_RDF]['RDF'][0]['child'][$namespace][$tag])) {
return $this->data['child'][self::NAMESPACE_RDF]['RDF'][0]['child'][$namespace][$tag];
}
}
if ($type & self::TYPE_RSS_SYNDICATION) {
if (isset($this->data['child'][self::NAMESPACE_RSS_20]['rss'][0]['child'][$namespace][$tag])) {
return $this->data['child'][self::NAMESPACE_RSS_20]['rss'][0]['child'][$namespace][$tag];
}
}
return null;
}
/**
* Get data for an channel-level element
*
* This method allows you to get access to ANY element/attribute in the
* channel/header section of the feed.
*
* See {@see SimplePie::get_feed_tags()} for a description of the return value
*
* @since 1.0
* @see http://simplepie.org/wiki/faq/supported_xml_namespaces
* @param string $namespace The URL of the XML namespace of the elements you're trying to access
* @param string $tag Tag name
* @return array
*/
public function get_channel_tags($namespace, $tag)
{
$type = $this->get_type();
if ($type & self::TYPE_ATOM_ALL) {
if ($return = $this->get_feed_tags($namespace, $tag)) {
return $return;
}
}
if ($type & self::TYPE_RSS_10) {
if ($channel = $this->get_feed_tags(self::NAMESPACE_RSS_10, 'channel')) {
if (isset($channel[0]['child'][$namespace][$tag])) {
return $channel[0]['child'][$namespace][$tag];
}
}
}
if ($type & self::TYPE_RSS_090) {
if ($channel = $this->get_feed_tags(self::NAMESPACE_RSS_090, 'channel')) {
if (isset($channel[0]['child'][$namespace][$tag])) {
return $channel[0]['child'][$namespace][$tag];
}
}
}
if ($type & self::TYPE_RSS_SYNDICATION) {
if ($channel = $this->get_feed_tags(self::NAMESPACE_RSS_20, 'channel')) {
if (isset($channel[0]['child'][$namespace][$tag])) {
return $channel[0]['child'][$namespace][$tag];
}
}
}
return null;
}
/**
* Get data for an channel-level element
*
* This method allows you to get access to ANY element/attribute in the
* image/logo section of the feed.
*
* See {@see SimplePie::get_feed_tags()} for a description of the return value
*
* @since 1.0
* @see http://simplepie.org/wiki/faq/supported_xml_namespaces
* @param string $namespace The URL of the XML namespace of the elements you're trying to access
* @param string $tag Tag name
* @return array
*/
public function get_image_tags($namespace, $tag)
{
$type = $this->get_type();
if ($type & self::TYPE_RSS_10) {
if ($image = $this->get_feed_tags(self::NAMESPACE_RSS_10, 'image')) {
if (isset($image[0]['child'][$namespace][$tag])) {
return $image[0]['child'][$namespace][$tag];
}
}
}
if ($type & self::TYPE_RSS_090) {
if ($image = $this->get_feed_tags(self::NAMESPACE_RSS_090, 'image')) {
if (isset($image[0]['child'][$namespace][$tag])) {
return $image[0]['child'][$namespace][$tag];
}
}
}
if ($type & self::TYPE_RSS_SYNDICATION) {
if ($image = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'image')) {
if (isset($image[0]['child'][$namespace][$tag])) {
return $image[0]['child'][$namespace][$tag];
}
}
}
return null;
}
/**
* Get the base URL value from the feed
*
* Uses `` if available, otherwise uses the first link in the
* feed, or failing that, the URL of the feed itself.
*
* @see get_link
* @see subscribe_url
*
* @param array $element
* @return string
*/
public function get_base($element = [])
{
if (!empty($element['xml_base_explicit']) && isset($element['xml_base'])) {
return $element['xml_base'];
} elseif ($this->get_link() !== null) {
return $this->get_link();
}
return $this->subscribe_url();
}
/**
* Sanitize feed data
*
* @access private
* @see \SimplePie\Sanitize::sanitize()
* @param string $data Data to sanitize
* @param int $type One of the \SimplePie\SimplePie::CONSTRUCT_* constants
* @param string $base Base URL to resolve URLs against
* @return string Sanitized data
*/
public function sanitize($data, $type, $base = '')
{
try {
return $this->sanitize->sanitize($data, $type, $base);
} catch (\SimplePie\Exception $e) {
if (!$this->enable_exceptions) {
$this->error = $e->getMessage();
$this->registry->call(Misc::class, 'error', [$this->error, E_USER_WARNING, $e->getFile(), $e->getLine()]);
return '';
}
throw $e;
}
}
/**
* Get the title of the feed
*
* Uses ``, `` or ``
*
* @since 1.0 (previously called `get_feed_title` since 0.8)
* @return string|null
*/
public function get_title()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'title')) {
return $this->sanitize($return[0]['data'], $this->registry->call(Misc::class, 'atom_10_construct_type', [$return[0]['attribs']]), $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_03, 'title')) {
return $this->sanitize($return[0]['data'], $this->registry->call(Misc::class, 'atom_03_construct_type', [$return[0]['attribs']]), $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_10, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_090, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_11, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_10, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
}
return null;
}
/**
* Get a category for the feed
*
* @since Unknown
* @param int $key The category that you want to return. Remember that arrays begin with 0, not 1
* @return \SimplePie\Category|null
*/
public function get_category($key = 0)
{
$categories = $this->get_categories();
if (isset($categories[$key])) {
return $categories[$key];
}
return null;
}
/**
* Get all categories for the feed
*
* Uses ``, `` or ``
*
* @since Unknown
* @return array|null List of {@see \SimplePie\Category} objects
*/
public function get_categories()
{
$categories = [];
foreach ((array) $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'category') as $category) {
$term = null;
$scheme = null;
$label = null;
if (isset($category['attribs']['']['term'])) {
$term = $this->sanitize($category['attribs']['']['term'], self::CONSTRUCT_TEXT);
}
if (isset($category['attribs']['']['scheme'])) {
$scheme = $this->sanitize($category['attribs']['']['scheme'], self::CONSTRUCT_TEXT);
}
if (isset($category['attribs']['']['label'])) {
$label = $this->sanitize($category['attribs']['']['label'], self::CONSTRUCT_TEXT);
}
$categories[] = $this->registry->create(Category::class, [$term, $scheme, $label]);
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_RSS_20, 'category') as $category) {
// This is really the label, but keep this as the term also for BC.
// Label will also work on retrieving because that falls back to term.
$term = $this->sanitize($category['data'], self::CONSTRUCT_TEXT);
if (isset($category['attribs']['']['domain'])) {
$scheme = $this->sanitize($category['attribs']['']['domain'], self::CONSTRUCT_TEXT);
} else {
$scheme = null;
}
$categories[] = $this->registry->create(Category::class, [$term, $scheme, null]);
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_DC_11, 'subject') as $category) {
$categories[] = $this->registry->create(Category::class, [$this->sanitize($category['data'], self::CONSTRUCT_TEXT), null, null]);
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_DC_10, 'subject') as $category) {
$categories[] = $this->registry->create(Category::class, [$this->sanitize($category['data'], self::CONSTRUCT_TEXT), null, null]);
}
if (!empty($categories)) {
return array_unique($categories);
}
return null;
}
/**
* Get an author for the feed
*
* @since 1.1
* @param int $key The author that you want to return. Remember that arrays begin with 0, not 1
* @return \SimplePie\Author|null
*/
public function get_author($key = 0)
{
$authors = $this->get_authors();
if (isset($authors[$key])) {
return $authors[$key];
}
return null;
}
/**
* Get all authors for the feed
*
* Uses ``, ``, `` or ``
*
* @since 1.1
* @return array|null List of {@see \SimplePie\Author} objects
*/
public function get_authors()
{
$authors = [];
foreach ((array) $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'author') as $author) {
$name = null;
$uri = null;
$email = null;
if (isset($author['child'][self::NAMESPACE_ATOM_10]['name'][0]['data'])) {
$name = $this->sanitize($author['child'][self::NAMESPACE_ATOM_10]['name'][0]['data'], self::CONSTRUCT_TEXT);
}
if (isset($author['child'][self::NAMESPACE_ATOM_10]['uri'][0]['data'])) {
$uri = $this->sanitize($author['child'][self::NAMESPACE_ATOM_10]['uri'][0]['data'], self::CONSTRUCT_IRI, $this->get_base($author['child'][self::NAMESPACE_ATOM_10]['uri'][0]));
}
if (isset($author['child'][self::NAMESPACE_ATOM_10]['email'][0]['data'])) {
$email = $this->sanitize($author['child'][self::NAMESPACE_ATOM_10]['email'][0]['data'], self::CONSTRUCT_TEXT);
}
if ($name !== null || $email !== null || $uri !== null) {
$authors[] = $this->registry->create(Author::class, [$name, $uri, $email]);
}
}
if ($author = $this->get_channel_tags(self::NAMESPACE_ATOM_03, 'author')) {
$name = null;
$url = null;
$email = null;
if (isset($author[0]['child'][self::NAMESPACE_ATOM_03]['name'][0]['data'])) {
$name = $this->sanitize($author[0]['child'][self::NAMESPACE_ATOM_03]['name'][0]['data'], self::CONSTRUCT_TEXT);
}
if (isset($author[0]['child'][self::NAMESPACE_ATOM_03]['url'][0]['data'])) {
$url = $this->sanitize($author[0]['child'][self::NAMESPACE_ATOM_03]['url'][0]['data'], self::CONSTRUCT_IRI, $this->get_base($author[0]['child'][self::NAMESPACE_ATOM_03]['url'][0]));
}
if (isset($author[0]['child'][self::NAMESPACE_ATOM_03]['email'][0]['data'])) {
$email = $this->sanitize($author[0]['child'][self::NAMESPACE_ATOM_03]['email'][0]['data'], self::CONSTRUCT_TEXT);
}
if ($name !== null || $email !== null || $url !== null) {
$authors[] = $this->registry->create(Author::class, [$name, $url, $email]);
}
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_DC_11, 'creator') as $author) {
$authors[] = $this->registry->create(Author::class, [$this->sanitize($author['data'], self::CONSTRUCT_TEXT), null, null]);
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_DC_10, 'creator') as $author) {
$authors[] = $this->registry->create(Author::class, [$this->sanitize($author['data'], self::CONSTRUCT_TEXT), null, null]);
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_ITUNES, 'author') as $author) {
$authors[] = $this->registry->create(Author::class, [$this->sanitize($author['data'], self::CONSTRUCT_TEXT), null, null]);
}
if (!empty($authors)) {
return array_unique($authors);
}
return null;
}
/**
* Get a contributor for the feed
*
* @since 1.1
* @param int $key The contrbutor that you want to return. Remember that arrays begin with 0, not 1
* @return \SimplePie\Author|null
*/
public function get_contributor($key = 0)
{
$contributors = $this->get_contributors();
if (isset($contributors[$key])) {
return $contributors[$key];
}
return null;
}
/**
* Get all contributors for the feed
*
* Uses ``
*
* @since 1.1
* @return array|null List of {@see \SimplePie\Author} objects
*/
public function get_contributors()
{
$contributors = [];
foreach ((array) $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'contributor') as $contributor) {
$name = null;
$uri = null;
$email = null;
if (isset($contributor['child'][self::NAMESPACE_ATOM_10]['name'][0]['data'])) {
$name = $this->sanitize($contributor['child'][self::NAMESPACE_ATOM_10]['name'][0]['data'], self::CONSTRUCT_TEXT);
}
if (isset($contributor['child'][self::NAMESPACE_ATOM_10]['uri'][0]['data'])) {
$uri = $this->sanitize($contributor['child'][self::NAMESPACE_ATOM_10]['uri'][0]['data'], self::CONSTRUCT_IRI, $this->get_base($contributor['child'][self::NAMESPACE_ATOM_10]['uri'][0]));
}
if (isset($contributor['child'][self::NAMESPACE_ATOM_10]['email'][0]['data'])) {
$email = $this->sanitize($contributor['child'][self::NAMESPACE_ATOM_10]['email'][0]['data'], self::CONSTRUCT_TEXT);
}
if ($name !== null || $email !== null || $uri !== null) {
$contributors[] = $this->registry->create(Author::class, [$name, $uri, $email]);
}
}
foreach ((array) $this->get_channel_tags(self::NAMESPACE_ATOM_03, 'contributor') as $contributor) {
$name = null;
$url = null;
$email = null;
if (isset($contributor['child'][self::NAMESPACE_ATOM_03]['name'][0]['data'])) {
$name = $this->sanitize($contributor['child'][self::NAMESPACE_ATOM_03]['name'][0]['data'], self::CONSTRUCT_TEXT);
}
if (isset($contributor['child'][self::NAMESPACE_ATOM_03]['url'][0]['data'])) {
$url = $this->sanitize($contributor['child'][self::NAMESPACE_ATOM_03]['url'][0]['data'], self::CONSTRUCT_IRI, $this->get_base($contributor['child'][self::NAMESPACE_ATOM_03]['url'][0]));
}
if (isset($contributor['child'][self::NAMESPACE_ATOM_03]['email'][0]['data'])) {
$email = $this->sanitize($contributor['child'][self::NAMESPACE_ATOM_03]['email'][0]['data'], self::CONSTRUCT_TEXT);
}
if ($name !== null || $email !== null || $url !== null) {
$contributors[] = $this->registry->create(Author::class, [$name, $url, $email]);
}
}
if (!empty($contributors)) {
return array_unique($contributors);
}
return null;
}
/**
* Get a single link for the feed
*
* @since 1.0 (previously called `get_feed_link` since Preview Release, `get_feed_permalink()` since 0.8)
* @param int $key The link that you want to return. Remember that arrays begin with 0, not 1
* @param string $rel The relationship of the link to return
* @return string|null Link URL
*/
public function get_link($key = 0, $rel = 'alternate')
{
$links = $this->get_links($rel);
if (isset($links[$key])) {
return $links[$key];
}
return null;
}
/**
* Get the permalink for the item
*
* Returns the first link available with a relationship of "alternate".
* Identical to {@see get_link()} with key 0
*
* @see get_link
* @since 1.0 (previously called `get_feed_link` since Preview Release, `get_feed_permalink()` since 0.8)
* @internal Added for parity between the parent-level and the item/entry-level.
* @return string|null Link URL
*/
public function get_permalink()
{
return $this->get_link(0);
}
/**
* Get all links for the feed
*
* Uses `` or ``
*
* @since Beta 2
* @param string $rel The relationship of links to return
* @return array|null Links found for the feed (strings)
*/
public function get_links($rel = 'alternate')
{
if (!isset($this->data['links'])) {
$this->data['links'] = [];
if ($links = $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'link')) {
foreach ($links as $link) {
if (isset($link['attribs']['']['href'])) {
$link_rel = (isset($link['attribs']['']['rel'])) ? $link['attribs']['']['rel'] : 'alternate';
$this->data['links'][$link_rel][] = $this->sanitize($link['attribs']['']['href'], self::CONSTRUCT_IRI, $this->get_base($link));
}
}
}
if ($links = $this->get_channel_tags(self::NAMESPACE_ATOM_03, 'link')) {
foreach ($links as $link) {
if (isset($link['attribs']['']['href'])) {
$link_rel = (isset($link['attribs']['']['rel'])) ? $link['attribs']['']['rel'] : 'alternate';
$this->data['links'][$link_rel][] = $this->sanitize($link['attribs']['']['href'], self::CONSTRUCT_IRI, $this->get_base($link));
}
}
}
if ($links = $this->get_channel_tags(self::NAMESPACE_RSS_10, 'link')) {
$this->data['links']['alternate'][] = $this->sanitize($links[0]['data'], self::CONSTRUCT_IRI, $this->get_base($links[0]));
}
if ($links = $this->get_channel_tags(self::NAMESPACE_RSS_090, 'link')) {
$this->data['links']['alternate'][] = $this->sanitize($links[0]['data'], self::CONSTRUCT_IRI, $this->get_base($links[0]));
}
if ($links = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'link')) {
$this->data['links']['alternate'][] = $this->sanitize($links[0]['data'], self::CONSTRUCT_IRI, $this->get_base($links[0]));
}
$keys = array_keys($this->data['links']);
foreach ($keys as $key) {
if ($this->registry->call(Misc::class, 'is_isegment_nz_nc', [$key])) {
if (isset($this->data['links'][self::IANA_LINK_RELATIONS_REGISTRY . $key])) {
$this->data['links'][self::IANA_LINK_RELATIONS_REGISTRY . $key] = array_merge($this->data['links'][$key], $this->data['links'][self::IANA_LINK_RELATIONS_REGISTRY . $key]);
$this->data['links'][$key] = &$this->data['links'][self::IANA_LINK_RELATIONS_REGISTRY . $key];
} else {
$this->data['links'][self::IANA_LINK_RELATIONS_REGISTRY . $key] = &$this->data['links'][$key];
}
} elseif (substr($key, 0, 41) === self::IANA_LINK_RELATIONS_REGISTRY) {
$this->data['links'][substr($key, 41)] = &$this->data['links'][$key];
}
$this->data['links'][$key] = array_unique($this->data['links'][$key]);
}
}
if (isset($this->data['headers']['link'])) {
$link_headers = $this->data['headers']['link'];
if (is_array($link_headers)) {
$link_headers = implode(',', $link_headers);
}
// https://datatracker.ietf.org/doc/html/rfc8288
if (is_string($link_headers) &&
preg_match_all('/<(?P[^>]+)>\s*;\s*rel\s*=\s*(?P"?)' . preg_quote($rel) . '(?P=quote)\s*(?=,|$)/i', $link_headers, $matches)) {
return $matches['uri'];
}
}
if (isset($this->data['links'][$rel])) {
return $this->data['links'][$rel];
}
return null;
}
public function get_all_discovered_feeds()
{
return $this->all_discovered_feeds;
}
/**
* Get the content for the item
*
* Uses ``, ``, ``,
* ``, `` or ``
*
* @since 1.0 (previously called `get_feed_description()` since 0.8)
* @return string|null
*/
public function get_description()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'subtitle')) {
return $this->sanitize($return[0]['data'], $this->registry->call(Misc::class, 'atom_10_construct_type', [$return[0]['attribs']]), $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_03, 'tagline')) {
return $this->sanitize($return[0]['data'], $this->registry->call(Misc::class, 'atom_03_construct_type', [$return[0]['attribs']]), $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_10, 'description')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_090, 'description')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'description')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_11, 'description')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_10, 'description')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ITUNES, 'summary')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_HTML, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ITUNES, 'subtitle')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_HTML, $this->get_base($return[0]));
}
return null;
}
/**
* Get the copyright info for the feed
*
* Uses ``, `` or ``
*
* @since 1.0 (previously called `get_feed_copyright()` since 0.8)
* @return string|null
*/
public function get_copyright()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'rights')) {
return $this->sanitize($return[0]['data'], $this->registry->call(Misc::class, 'atom_10_construct_type', [$return[0]['attribs']]), $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_03, 'copyright')) {
return $this->sanitize($return[0]['data'], $this->registry->call(Misc::class, 'atom_03_construct_type', [$return[0]['attribs']]), $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'copyright')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_11, 'rights')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_10, 'rights')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
}
return null;
}
/**
* Get the language for the feed
*
* Uses ``, ``, or @xml_lang
*
* @since 1.0 (previously called `get_feed_language()` since 0.8)
* @return string|null
*/
public function get_language()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'language')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_11, 'language')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_DC_10, 'language')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif (isset($this->data['child'][self::NAMESPACE_ATOM_10]['feed'][0]['xml_lang'])) {
return $this->sanitize($this->data['child'][self::NAMESPACE_ATOM_10]['feed'][0]['xml_lang'], self::CONSTRUCT_TEXT);
} elseif (isset($this->data['child'][self::NAMESPACE_ATOM_03]['feed'][0]['xml_lang'])) {
return $this->sanitize($this->data['child'][self::NAMESPACE_ATOM_03]['feed'][0]['xml_lang'], self::CONSTRUCT_TEXT);
} elseif (isset($this->data['child'][self::NAMESPACE_RDF]['RDF'][0]['xml_lang'])) {
return $this->sanitize($this->data['child'][self::NAMESPACE_RDF]['RDF'][0]['xml_lang'], self::CONSTRUCT_TEXT);
} elseif (isset($this->data['headers']['content-language'])) {
return $this->sanitize($this->data['headers']['content-language'], self::CONSTRUCT_TEXT);
}
return null;
}
/**
* Get the latitude coordinates for the item
*
* Compatible with the W3C WGS84 Basic Geo and GeoRSS specifications
*
* Uses `` or ``
*
* @since 1.0
* @link http://www.w3.org/2003/01/geo/ W3C WGS84 Basic Geo
* @link http://www.georss.org/ GeoRSS
* @return string|null
*/
public function get_latitude()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_W3C_BASIC_GEO, 'lat')) {
return (float) $return[0]['data'];
} elseif (($return = $this->get_channel_tags(self::NAMESPACE_GEORSS, 'point')) && preg_match('/^((?:-)?[0-9]+(?:\.[0-9]+)) ((?:-)?[0-9]+(?:\.[0-9]+))$/', trim($return[0]['data']), $match)) {
return (float) $match[1];
}
return null;
}
/**
* Get the longitude coordinates for the feed
*
* Compatible with the W3C WGS84 Basic Geo and GeoRSS specifications
*
* Uses ``, `` or ``
*
* @since 1.0
* @link http://www.w3.org/2003/01/geo/ W3C WGS84 Basic Geo
* @link http://www.georss.org/ GeoRSS
* @return string|null
*/
public function get_longitude()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_W3C_BASIC_GEO, 'long')) {
return (float) $return[0]['data'];
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_W3C_BASIC_GEO, 'lon')) {
return (float) $return[0]['data'];
} elseif (($return = $this->get_channel_tags(self::NAMESPACE_GEORSS, 'point')) && preg_match('/^((?:-)?[0-9]+(?:\.[0-9]+)) ((?:-)?[0-9]+(?:\.[0-9]+))$/', trim($return[0]['data']), $match)) {
return (float) $match[2];
}
return null;
}
/**
* Get the feed logo's title
*
* RSS 0.9.0, 1.0 and 2.0 feeds are allowed to have a "feed logo" title.
*
* Uses `` or ``
*
* @return string|null
*/
public function get_image_title()
{
if ($return = $this->get_image_tags(self::NAMESPACE_RSS_10, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_090, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_20, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_image_tags(self::NAMESPACE_DC_11, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
} elseif ($return = $this->get_image_tags(self::NAMESPACE_DC_10, 'title')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_TEXT);
}
return null;
}
/**
* Get the feed logo's URL
*
* RSS 0.9.0, 2.0, Atom 1.0, and feeds with iTunes RSS tags are allowed to
* have a "feed logo" URL. This points directly to the image itself.
*
* Uses ``, ``, ``,
* `` or ``
*
* @return string|null
*/
public function get_image_url()
{
if ($return = $this->get_channel_tags(self::NAMESPACE_ITUNES, 'image')) {
return $this->sanitize($return[0]['attribs']['']['href'], self::CONSTRUCT_IRI);
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'logo')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
} elseif ($return = $this->get_channel_tags(self::NAMESPACE_ATOM_10, 'icon')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_10, 'url')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_090, 'url')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_20, 'url')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
}
return null;
}
/**
* Get the feed logo's link
*
* RSS 0.9.0, 1.0 and 2.0 feeds are allowed to have a "feed logo" link. This
* points to a human-readable page that the image should link to.
*
* Uses ``, ``, ``,
* `` or ``
*
* @return string|null
*/
public function get_image_link()
{
if ($return = $this->get_image_tags(self::NAMESPACE_RSS_10, 'link')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_090, 'link')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
} elseif ($return = $this->get_image_tags(self::NAMESPACE_RSS_20, 'link')) {
return $this->sanitize($return[0]['data'], self::CONSTRUCT_IRI, $this->get_base($return[0]));
}
return null;
}
/**
* Get the feed logo's link
*
* RSS 2.0 feeds are allowed to have a "feed logo" width.
*
* Uses `` or defaults to 88 if no width is specified and
* the feed is an RSS 2.0 feed.
*
* @return int|null
*/
public function get_image_width()
{
if ($return = $this->get_image_tags(self::NAMESPACE_RSS_20, 'width')) {
return intval($return[0]['data']);
} elseif ($this->get_type() & self::TYPE_RSS_SYNDICATION && $this->get_image_tags(self::NAMESPACE_RSS_20, 'url')) {
return 88;
}
return null;
}
/**
* Get the feed logo's height
*
* RSS 2.0 feeds are allowed to have a "feed logo" height.
*
* Uses `` or defaults to 31 if no height is specified and
* the feed is an RSS 2.0 feed.
*
* @return int|null
*/
public function get_image_height()
{
if ($return = $this->get_image_tags(self::NAMESPACE_RSS_20, 'height')) {
return intval($return[0]['data']);
} elseif ($this->get_type() & self::TYPE_RSS_SYNDICATION && $this->get_image_tags(self::NAMESPACE_RSS_20, 'url')) {
return 31;
}
return null;
}
/**
* Get the number of items in the feed
*
* This is well-suited for {@link http://php.net/for for()} loops with
* {@see get_item()}
*
* @param int $max Maximum value to return. 0 for no limit
* @return int Number of items in the feed
*/
public function get_item_quantity($max = 0)
{
$max = (int) $max;
$qty = count($this->get_items());
if ($max === 0) {
return $qty;
}
return ($qty > $max) ? $max : $qty;
}
/**
* Get a single item from the feed
*
* This is better suited for {@link http://php.net/for for()} loops, whereas
* {@see get_items()} is better suited for
* {@link http://php.net/foreach foreach()} loops.
*
* @see get_item_quantity()
* @since Beta 2
* @param int $key The item that you want to return. Remember that arrays begin with 0, not 1
* @return \SimplePie\Item|null
*/
public function get_item($key = 0)
{
$items = $this->get_items();
if (isset($items[$key])) {
return $items[$key];
}
return null;
}
/**
* Get all items from the feed
*
* This is better suited for {@link http://php.net/for for()} loops, whereas
* {@see get_items()} is better suited for
* {@link http://php.net/foreach foreach()} loops.
*
* @see get_item_quantity
* @since Beta 2
* @param int $start Index to start at
* @param int $end Number of items to return. 0 for all items after `$start`
* @return \SimplePie\Item[]|null List of {@see \SimplePie\Item} objects
*/
public function get_items($start = 0, $end = 0)
{
if (!isset($this->data['items'])) {
if (!empty($this->multifeed_objects)) {
$this->data['items'] = SimplePie::merge_items($this->multifeed_objects, $start, $end, $this->item_limit);
if (empty($this->data['items'])) {
return [];
}
return $this->data['items'];
}
$this->data['items'] = [];
if ($items = $this->get_feed_tags(self::NAMESPACE_ATOM_10, 'entry')) {
$keys = array_keys($items);
foreach ($keys as $key) {
$this->data['items'][] = $this->registry->create(Item::class, [$this, $items[$key]]);
}
}
if ($items = $this->get_feed_tags(self::NAMESPACE_ATOM_03, 'entry')) {
$keys = array_keys($items);
foreach ($keys as $key) {
$this->data['items'][] = $this->registry->create(Item::class, [$this, $items[$key]]);
}
}
if ($items = $this->get_feed_tags(self::NAMESPACE_RSS_10, 'item')) {
$keys = array_keys($items);
foreach ($keys as $key) {
$this->data['items'][] = $this->registry->create(Item::class, [$this, $items[$key]]);
}
}
if ($items = $this->get_feed_tags(self::NAMESPACE_RSS_090, 'item')) {
$keys = array_keys($items);
foreach ($keys as $key) {
$this->data['items'][] = $this->registry->create(Item::class, [$this, $items[$key]]);
}
}
if ($items = $this->get_channel_tags(self::NAMESPACE_RSS_20, 'item')) {
$keys = array_keys($items);
foreach ($keys as $key) {
$this->data['items'][] = $this->registry->create(Item::class, [$this, $items[$key]]);
}
}
}
if (empty($this->data['items'])) {
return [];
}
if ($this->order_by_date) {
if (!isset($this->data['ordered_items'])) {
$this->data['ordered_items'] = $this->data['items'];
usort($this->data['ordered_items'], [get_class($this), 'sort_items']);
}
$items = $this->data['ordered_items'];
} else {
$items = $this->data['items'];
}
// Slice the data as desired
if ($end === 0) {
return array_slice($items, $start);
}
return array_slice($items, $start, $end);
}
/**
* Set the favicon handler
*
* @deprecated Use your own favicon handling instead
*/
public function set_favicon_handler($page = false, $qs = 'i')
{
trigger_error('Favicon handling has been removed, please use your own handling', \E_USER_DEPRECATED);
return false;
}
/**
* Get the favicon for the current feed
*
* @deprecated Use your own favicon handling instead
*/
public function get_favicon()
{
trigger_error('Favicon handling has been removed, please use your own handling', \E_USER_DEPRECATED);
if (($url = $this->get_link()) !== null) {
return 'https://www.google.com/s2/favicons?domain=' . urlencode($url);
}
return false;
}
/**
* Magic method handler
*
* @param string $method Method name
* @param array $args Arguments to the method
* @return mixed
*/
public function __call($method, $args)
{
if (strpos($method, 'subscribe_') === 0) {
trigger_error('subscribe_*() has been deprecated, implement the callback yourself', \E_USER_DEPRECATED);
return '';
}
if ($method === 'enable_xml_dump') {
trigger_error('enable_xml_dump() has been deprecated, use get_raw_data() instead', \E_USER_DEPRECATED);
return false;
}
$class = get_class($this);
$trace = debug_backtrace(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
$file = $trace[0]['file'];
$line = $trace[0]['line'];
throw new SimplePieException("Call to undefined method $class::$method() in $file on line $line");
}
/**
* Sorting callback for items
*
* @access private
* @param SimplePie $a
* @param SimplePie $b
* @return boolean
*/
public static function sort_items($a, $b)
{
$a_date = $a->get_date('U');
$b_date = $b->get_date('U');
if ($a_date && $b_date) {
return $a_date > $b_date ? -1 : 1;
}
// Sort items without dates to the top.
if ($a_date) {
return 1;
}
if ($b_date) {
return -1;
}
return 0;
}
/**
* Merge items from several feeds into one
*
* If you're merging multiple feeds together, they need to all have dates
* for the items or else SimplePie will refuse to sort them.
*
* @link http://simplepie.org/wiki/tutorial/sort_multiple_feeds_by_time_and_date#if_feeds_require_separate_per-feed_settings
* @param array $urls List of SimplePie feed objects to merge
* @param int $start Starting item
* @param int $end Number of items to return
* @param int $limit Maximum number of items per feed
* @return array
*/
public static function merge_items($urls, $start = 0, $end = 0, $limit = 0)
{
if (is_array($urls) && sizeof($urls) > 0) {
$items = [];
foreach ($urls as $arg) {
if ($arg instanceof SimplePie) {
$items = array_merge($items, $arg->get_items(0, $limit));
} else {
trigger_error('Arguments must be SimplePie objects', E_USER_WARNING);
}
}
usort($items, [get_class($urls[0]), 'sort_items']);
if ($end === 0) {
return array_slice($items, $start);
}
return array_slice($items, $start, $end);
}
trigger_error('Cannot merge zero SimplePie objects', E_USER_WARNING);
return [];
}
/**
* Store PubSubHubbub links as headers
*
* There is no way to find PuSH links in the body of a microformats feed,
* so they are added to the headers when found, to be used later by get_links.
* @param \SimplePie\File $file
* @param string $hub
* @param string $self
*/
private function store_links(&$file, $hub, $self)
{
if (isset($file->headers['link']['hub']) ||
(isset($file->headers['link']) &&
preg_match('/rel=hub/', $file->headers['link']))) {
return;
}
if ($hub) {
if (isset($file->headers['link'])) {
if ($file->headers['link'] !== '') {
$file->headers['link'] = ', ';
}
} else {
$file->headers['link'] = '';
}
$file->headers['link'] .= '<'.$hub.'>; rel=hub';
if ($self) {
$file->headers['link'] .= ', <'.$self.'>; rel=self';
}
}
}
/**
* Get a DataCache
*
* @param string $feed_url Only needed for BC, can be removed in SimplePie 2.0.0
*
* @return DataCache
*/
private function get_cache($feed_url = '')
{
if ($this->cache === null) {
// @trigger_error(sprintf('Not providing as PSR-16 cache implementation is deprecated since SimplePie 1.8.0, please use "SimplePie\SimplePie::set_cache()".'), \E_USER_DEPRECATED);
$cache = $this->registry->call(Cache::class, 'get_handler', [
$this->cache_location,
$this->get_cache_filename($feed_url),
Base::TYPE_FEED
]);
return new BaseDataCache($cache);
}
return $this->cache;
}
}
class_alias('SimplePie\SimplePie', 'SimplePie');