mamuz/mamuz-blog-feed

1.0.1 2015-08-20 19:21 UTC

README

Build Status Coverage Status Scrutinizer Code Quality SensioLabsInsight HHVM Status Dependency Status

Latest Stable Version Latest Unstable Version Total Downloads License

Features

  • This module provides a plugin for mamuz/mamuz-blog to create Feeds
  • Atom and RSS feeds are supported
  • Adds alternative link to html head automaticly
  • Feeds for all Posts and for Posts found by Tag are provided
  • Each feed is configurable seperatly

Installation

The recommended way to install mamuz/mamuz-blog-feed is through composer by adding dependency to your composer.json:

{
    "require": {
        "mamuz/mamuz-blog-feed": "*"
    }
}

After that run composer update and enable this module for ZF2 by adding MamuzBlogFeed to modules in ./config/application.config.php:

// ...
    'modules' => array(
        'MamuzBlogFeed',
    ),

Configuration

This module is usable out of the box, but you can overwrite default configuration by adding a config file in ./config/autoload directory. For default configuration see module.config.php

Workflow

  • If routing is successful, posts will be retrieved either with tag parameter or without tag parameter to create a feed xml and responding to http response object.
  • If event Event::PRE_PAGINATION_CREATE is triggert by posts retrieval and autoHeadLink is set to true for specific feed, an alternative link to html head is appended automaticly.

Events

For the sake of simplicity Event is used for FQN MamuzBlogFeed\EventManager\Event.

The following events are triggered by Event::IDENTIFIER mamuz-blog:

Name Constant Description
createFeed.pre Event::PRE_FEED_CREATE Before feed creation
createFeed.post Event::POST_FEED_CREATE After feed creation

Terminology

  • Feed: Web format to publish frequently updated informations (here blog articles).