Download the PHP package baraja-core/wordpress-post-feed without Composer

BRJ organisation

WordPress Post Feed

A lightweight PHP library for fetching, parsing, and caching WordPress RSS feeds with automatic image handling.

The library provides a simple API to download blog posts from any WordPress RSS feed, automatically caches the content to minimize network requests, and handles image downloading and local storage for improved performance and reliability.

:sparkles: Key Features

• Automatic RSS feed parsing - Extracts posts with title, description, link, date, author, and categories
• Smart caching system - Feed content is cached with configurable expiration time (default: 2 hours)
• Image management - Automatically downloads and stores post images locally
• Pagination support - Built-in limit and offset parameters for easy pagination
• Zero-config usage - Works out of the box without any dependencies when used standalone
• Nette Framework integration - Full DI container support with configurable extension
• Security-first image handling - Validates image types before saving to prevent malicious files

:building_construction: Architecture Overview

The library consists of four main components that work together to provide a complete feed management solution:

:package: Components

:package: Installation

It's best to use Composer for installation, and you can also find the package on Packagist and GitHub.

To install, simply use the command:

You can use the package manually by creating an instance of the internal classes, or register a DIC extension to link the services directly to the Nette Framework.

Requirements

• PHP 8.0 or higher
• ext-curl extension
• Nette Caching component (installed automatically)

:gear: Configuration

Standalone Usage

The library works out of the box without any configuration:

By default, the Feed service will:

• Create a temporary directory for caching in the system temp folder
• Set cache expiration to 2 hours
• Create an ImageStorage instance with default settings

Nette Framework Integration

If you are installing the package into the Nette Framework, register the extension in your configuration:

Advanced Configuration

The extension supports the following configuration options:

:rocket: Basic Usage

Loading Posts from a Feed

The feed will be downloaded automatically, then cached and further requests will be handled instantly straight from the cache.

Pagination with Limit and Offset

If you only need to retrieve some posts from the feed, use the limit and offset arguments:

Post Entity Methods

The Post entity provides the following methods:

:floppy_disk: Caching System

How Caching Works

Posts are automatically cached for the set period (default 2 hours). The caching system operates on two levels:

1. Raw feed caching - The downloaded XML feed is cached to avoid repeated HTTP requests
2. Parsed post caching - The parsed Post objects are cached separately for each limit/offset combination

When the cache expires, the next request will:

1. Download the fresh feed
2. Parse all posts
3. Store images locally
4. Update the cache

Cache Management

Manual Cache Update

If you want to refresh the cache before expiration (e.g., via cron job):

This is useful for ensuring all requests are served from cache instantly, even after expiration.

Clear All Cache

To completely clear the feed cache:

Recommended Cron Setup

For production environments, it's recommended to set up a cron job that refreshes the cache periodically:

This ensures that user requests are always served from cache and never have to wait for feed downloads.

:framed_picture: Image Manipulation

When downloading posts from the feed, images are automatically downloaded and copied to disk. The image storage is provided by the \Baraja\WordPressPostFeed\ImageStorage service, which is automatically registered by the library.

Default Storage Location

The default directory for storing images is wordpress-post-feed relative to your index.php (web root).

ImageStorage Service Methods

The service provides the following methods:

Working with Images from Posts

Working with images is also available directly from the Post entity:

Supported Image Formats

The library validates downloaded images and supports the following formats:

If a downloaded file is not a valid image of these types, a RuntimeException is thrown to prevent potential security issues.

Image Naming Strategy

Images are stored with a deterministic naming scheme to prevent collisions and ensure readability:

1. A 7-character MD5 hash prefix is generated from the URL
2. The original filename is sanitized (webalized) and truncated to 64 characters
3. Files are organized into subdirectories based on WordPress date structure (YYYY-MM) or URL hash

Example: https://blog.example.com/wp-content/uploads/2024/03/my-image.jpg becomes:

:hammer_and_wrench: Advanced Usage

Custom Cache Storage

You can provide your own cache storage implementation:

Custom Image Storage Location

Custom Expiration Time

Supported time formats include: '1 hour', '30 minutes', '2 days', etc.

Dependency Injection in Nette

When using the Nette Framework, you can inject the services directly:

:warning: Error Handling

The library handles errors gracefully:

• Empty feed response - Throws RuntimeException with descriptive message
• Invalid image format - Throws RuntimeException to prevent security issues
• Broken image URLs - Triggers a warning but continues processing
• Invalid feed URLs - Triggers a warning but continues processing
• Missing absolute URL in CLI - Throws LogicException with guidance

Example of handling errors:

:bust_in_silhouette: Author

Jan Barasek

• Website: https://baraja.cz
• GitHub: @janbarasek

:page_facing_up: License

baraja-core/wordpress-post-feed is licensed under the MIT license. See the LICENSE file for more details.