Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diego-brocanelli/podcast-rss-reader
component for easy handling and management of rss feed for podcasts.
https://github.com/diego-brocanelli/podcast-rss-reader
feed php php7 podcast rss
Last synced: 25 days ago
JSON representation
component for easy handling and management of rss feed for podcasts.
- Host: GitHub
- URL: https://github.com/diego-brocanelli/podcast-rss-reader
- Owner: Diego-Brocanelli
- License: mit
- Created: 2020-11-14T11:38:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-20T14:28:51.000Z (over 3 years ago)
- Last Synced: 2024-10-09T19:34:10.181Z (about 1 month ago)
- Topics: feed, php, php7, podcast, rss
- Language: PHP
- Homepage:
- Size: 42 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Podcast RSS Reader
Component for easy handling and management of rss feed for podcasts.
# How to use
## Requirements
PHP >= 7.4.
## Instalation
```bash
composer require diego-brocanelli/podcast-rss-reader dev-main
```
# How to contribute
Open an issue exposing your point to be analyzed, including detailing the point.
To contribute to the project, create a fork and send your pull request.
# Tests
```bash
composer tests
```
## Code Analysis
The command below will run PHPStan level 8 analysis.
```bash
composer analyse
```
## PHP Code Sniffer
The command below will run PHPStan level 8 analysis.
```bash
composer phpcs
```
## Test, Code Analysis and PHP Code Sniffer
```bash
composer all
```
# Example
```php
getEpisodes(); //Return: array
```
# Methods
## info(): array
Responsible for returning the base data of the rss feed, with the exception of episodes.
| Attribute | Type |
|---|---|
| title | string |
| link | string |
| description | string |
| lastBuildDate | DateTime |
| pubDate | DateTime |
| language | string |
## getImageInfo()
Responsible for returning the `DiegoBrocanelli\Podcast\Image` object with its attributes.
| Methods | Return |
|---|---|
| getTitle() | string |
| getUrl() | string |
| getLink() | string |
## getEpisodes()
Responsible for returning a list of `DiegoBrocanelli\Podcast\Episode` objects with their attributes.
| Methods | Return |
|---|---|
| getTitle() | string |
| getLink() | string |
| getPubDate() | DateTime |
| getGuid() | string |
| getComments() | string |
| getCategory() | string |
| getDescription() | string |
| getAudio() | string |
## lastBuildDate()
Responsible for returning the date for the last episode released, returning a `DateTime object`.
## biggerThen(DateTime $date): array
Allows you to set a date to search for episodes. Bringing all records located from the date informed.
# Author
# License
[MIT](https://github.com/Diego-Brocanelli/podcast-rss-reader/blob/main/LICENSE)