acelaya/zf2-acyaml

This package is abandoned and no longer maintained. No replacement package was suggested.

A Zend Framework 2 module to render yaml responses

v0.1.0 2014-11-23 11:52 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Total Downloads License

This module allows to work with Yaml responses the same way we do with JSON responses. Indeed, this module is pretty simple and is based on built-in JSON rendering classes (View\JsonStrategy, View\JsonRenderer and View\JsonModel) but using Symfony\Yaml instead of Zend\Json.

Installation

The only supported installation method is composer, however others could work too.

Get composer binary into your project.

curl -s http://getcomposer.org/installer | php

And run this command in order to get this module installed.

php composer.phar require acelaya/zf2-acyaml:~0.1

Finally add the module to your application.config.php file.

return array(
    'modules' => array(
        'Application',
        'Acelaya\Yaml' // <- Add this line
    )
);

Usage

The module will register a yaml view rendering strategy, so any action returning a YamlModel (which is very similar to the JsonModel) will make the response to be in yaml format, including the Content-type header with value application/x-yaml.

And that's it. No further configuration is needed. Nice and easy.