pqrs/checkrss

Check rss feeds for new items

CheckRSS

Check RSS feeds for new items, _(*1)

CheckRSS provides some methods to:, _(*2)

• Get all the items in a RSS feed
• Check which of those items is/are new since last check
• Write a log every time a checking for new items is run

It is recommended using CheckRSS with a cron job so you can get new items periodically, although you can run it manually too., _(*3)

Installation

composer require pqrs/checkrss=dev-master

Alternatively, add the dependency directly to your composer.json file:, _(*4)

"require": {
    "pqrs/checkrss": "dev-master"
}

Then add to your php code:, _(*5)

``` php require_once DIR . '/vendor/autoload.php'; // Autoload files using Composer autoload, <sub>(*6)</sub>

use CheckRSS\RSS;, <sub>(*7)</sub>

## Usage

### method getItems($feed_url)

This method gets **all the items** published in the rss feed and returns an object containing them.

``` php
$rss = new RSS;

$items = $rss->getItems("http://feeds.nbcnews.com/feeds/topstories");

An example of the object returned would be:, <sub>(*8)</sub>

SimpleXMLElement Object
(
    [guid] => https://www.nbcnews.com/storyline/hurricane-irma/...
    [title] => One-two punch of disease and Irma has left Florida citrus reeling
    [pubDate] => Sat, 10 Feb 2018 15:17:00 GMT
    [link] => https://www.nbcnews.com/storyline/hurricane-irma/...
    [description] => Hurricane Irma served as a knockout punch for many of Florida's...
)

method getNewItems($items)

This method checks which items in a feed (obtained with getItems) are new since the last a check was made., <sub>(*9)</sub>

Returns an object with just the new items., <sub>(*10)</sub>

``` php $rss = new RSS;, <sub>(*11)</sub>

// Gets all the items published in the rss feed and stores them in $items $items = $rss->getItems("http://feeds.nbcnews.com/feeds/topstories");, <sub>(*12)</sub>

// Checks which items are new since last check if ($newitems = $rss->getNewItems($items) ) {, <sub>(*13)</sub>

// Prints new items
echo "New items found:" . PHP_EOL . PHP_EOL;

foreach ($newitems as $value) {

    echo $value->title          . PHP_EOL;
    echo $value->description    . PHP_EOL;
    echo $value->guid           . PHP_EOL;
    echo $value->link           . PHP_EOL. PHP_EOL;

}

} else {, <sub>(*14)</sub>

echo "There'are no new items in RSS feed";

} ```, <sub>(*15)</sub>

method storeLastItemID($item_id)

Internal use. This method writes the last read item id in a file to compare it in future checks., <sub>(*16)</sub>

method isNewItem($item_id)

Internal use. This method compares the last read item id with the last stored one in previous check., <sub>(*17)</sub>

method WriteLog($logline)

A simple method to write a log file everytime a check is made., <sub>(*18)</sub>

Examples

You can find some uses for these functions in tests folder., <sub>(*19)</sub>

Prerequisites

PHP 5.3.0, <sub>(*20)</sub>

Contributing

Contributions are of course very welcome!, <sub>(*21)</sub>

Credits

Copyright © 2018 Alvaro Piqueras - pqrs, <sub>(*22)</sub>

This is a cleanup of a dirty code I wrote some time ago. Also it's my first try with GitHub, Composer and Packagist so if you find some mistakes or have some tips for me, I would be more than glad to hear you., <sub>(*23)</sub>

I hope this code suites your needs., <sub>(*24)</sub>

License

This project is licensed under the MIT License - see the LICENSE file for details., <sub>(*25)</sub>