Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix type hinting for php 8.4 and raise minimum PHP version to 7.1 #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix type hinting for php 8.4 and raise minimum PHP version to 7.1 #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
}
],
"require": {
"php": ">=5.3",
"php": ">=7.1",
"ext-simplexml": "*"
},
"autoload": {
Expand Down
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RSS & Atom Feeds for PHP

RSS & Atom Feeds for PHP is a very small and easy-to-use library for consuming an RSS and Atom feeds.

It requires PHP 5.3 or newer with CURL extension or enabled allow_url_fopen
It requires PHP 7.1 or newer with CURL extension or enabled allow_url_fopen
and is licensed under the New BSD License. You can obtain the latest version from
our [GitHub repository](https://github.com/dg/rss-php/releases) or install it via Composer:

Expand Down
132 changes: 66 additions & 66 deletions src/Feed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
*
* @copyright Copyright (c) 2008 David Grudl
* @license New BSD License
* @version 1.5
* @version 1.6
*/
class Feed
{
Expand All @@ -22,15 +22,15 @@ class Feed
protected $xml;


/**
* Loads RSS or Atom feed.
* @param string
* @param string
* @param string
* @return Feed
* @throws FeedException
*/
public static function load($url, $user = null, $pass = null)
/**
* Loads RSS or Atom feed.
* @param string $url
* @param string|null $user
* @param string|null $pass
* @return Feed
* @throws FeedException
*/
public static function load(string $url, ?string $user = null, ?string $pass = null): self
{
$xml = self::loadXml($url, $user, $pass);
if ($xml->channel) {
Expand All @@ -41,35 +41,35 @@ public static function load($url, $user = null, $pass = null)
}


/**
* Loads RSS feed.
* @param string RSS feed URL
* @param string optional user name
* @param string optional password
* @return Feed
* @throws FeedException
*/
public static function loadRss($url, $user = null, $pass = null)
/**
* Loads RSS feed.
* @param string $url RSS feed URL
* @param string|null $user
* @param string|null $pass
* @return Feed
* @throws FeedException
*/
public static function loadRss(string $url, ?string $user = null, ?string $pass = null): self
{
return self::fromRss(self::loadXml($url, $user, $pass));
}


/**
* Loads Atom feed.
* @param string Atom feed URL
* @param string optional user name
* @param string optional password
* @return Feed
* @throws FeedException
*/
public static function loadAtom($url, $user = null, $pass = null)
/**
* Loads Atom feed.
* @param string $url Atom feed URL
* @param string|null $user optional username
* @param string|null $pass optional password
* @return Feed
* @throws FeedException
*/
public static function loadAtom(string $url, ?string $user = null, ?string $pass = null): self
{
return self::fromAtom(self::loadXml($url, $user, $pass));
}


private static function fromRss(SimpleXMLElement $xml)
private static function fromRss(SimpleXMLElement $xml): self
{
if (!$xml->channel) {
throw new FeedException('Invalid feed.');
Expand All @@ -95,7 +95,7 @@ private static function fromRss(SimpleXMLElement $xml)
}


private static function fromAtom(SimpleXMLElement $xml)
private static function fromAtom(SimpleXMLElement $xml): self
{
if (!in_array('http://www.w3.org/2005/Atom', $xml->getDocNamespaces(), true)
&& !in_array('http://purl.org/atom/ns#', $xml->getDocNamespaces(), true)
Expand All @@ -116,33 +116,34 @@ private static function fromAtom(SimpleXMLElement $xml)

/**
* Returns property value. Do not call directly.
* @param string tag name
* @param string $name tag name
* @return SimpleXMLElement
*/
public function __get($name)
public function __get(string $name): SimpleXMLElement
{
return $this->xml->{$name};
}


/**
* Sets value of a property. Do not call directly.
* @param string property name
* @param mixed property value
* @return void
*/
public function __set($name, $value)
/**
* Sets value of a property. Do not call directly.
* @param string $name property name
* @param mixed $value property value
* @return void
* @throws Exception
*/
public function __set(string $name, string $value): void
{
throw new Exception("Cannot assign to a read-only property '$name'.");
}


/**
* Converts a SimpleXMLElement into an array.
* @param SimpleXMLElement
* @return array
*/
public function toArray(SimpleXMLElement $xml = null)
/**
* Converts a SimpleXMLElement into an array.
* @param SimpleXMLElement|null $xml
* @return array|string
*/
public function toArray(?SimpleXMLElement $xml = null)
{
if ($xml === null) {
$xml = $this->xml;
Expand All @@ -165,15 +166,15 @@ public function toArray(SimpleXMLElement $xml = null)
}


/**
* Load XML from cache or HTTP.
* @param string
* @param string
* @param string
* @return SimpleXMLElement
* @throws FeedException
*/
private static function loadXml($url, $user, $pass)
/**
* Load XML from cache or HTTP.
* @param string $url
* @param string|null $user
* @param string|null $pass
* @return SimpleXMLElement
* @throws FeedException
*/
private static function loadXml(string $url, ?string $user, ?string $pass): SimpleXMLElement
{
$e = self::$cacheExpire;
$cacheFile = self::$cacheDir . '/feed.' . md5(serialize(func_get_args())) . '.xml';
Expand All @@ -197,15 +198,14 @@ private static function loadXml($url, $user, $pass)
}


/**
* Process HTTP request.
* @param string
* @param string
* @param string
* @return string|false
* @throws FeedException
*/
private static function httpRequest($url, $user, $pass)
/**
* Process HTTP request.
* @param string $url
* @param string|null $user
* @param string|null $pass
* @return string|false
*/
private static function httpRequest(string $url, ?string $user, ?string $pass)
{
if (extension_loaded('curl')) {
$curl = curl_init();
Expand Down Expand Up @@ -246,10 +246,10 @@ private static function httpRequest($url, $user, $pass)

/**
* Generates better accessible namespaced tags.
* @param SimpleXMLElement
* @return void
* @param SimpleXMLElement $el
* @return void
*/
private static function adjustNamespaces($el)
private static function adjustNamespaces(SimpleXMLElement $el): void
{
foreach ($el->getNamespaces(true) as $prefix => $ns) {
if ($prefix === '') {
Expand Down