Search by 
netbrothers-gmbh / nb-feed
Get RSS-Feeds and save to json
v0.0.2
2023-09-07 12:09 UTC
Requires
- php: >=8.1
- ext-curl: *
- ext-json: *
- ext-simplexml: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.19
- phpstan/phpstan: ^1.10
README
NetBrothers NbFeed
This library pulls an RSS feed to your hard disk, transforms the items to an array and saves the results as a JSON file on your hard disk.
Installation
On the command prompt, change into your project's root directory and execute:
composer require netbrothers-gmbh/nb-feed
Configuration
NbFeed needs a readable and writeable directory. All other configurations are optional. The configuration depends on your environment. See the content of ConfigService.
| Variable | Description | Default |
|---|---|---|
| maxEntriesToSave | maximum number of feed items to be saved | 0 (all) |
| cacheMaxAge | maximum caching time of the file (in seconds) | 1800 sec |
| storagePath | absolute path to a readable and writeable directory | null |
| feedFileName | name of the file to write to/read from | nb-feed |
Example
There is an example file. To use it:
- Checkout the repository,
- run
composer install --no-dev, - run the example:
php ./example/netbrothers-feed.php.
Feel free to use the example file as a starting point for your own purposes.
Licence
MIT