acelaya / zf2-acyaml
A Zend Framework 2 module to render yaml responses
Requires
- php: >=5.3.0
- symfony/yaml: ~2.4
- zendframework/zend-eventmanager: ~2.2
- zendframework/zend-http: ~2.2
- zendframework/zend-loader: ~2.2
- zendframework/zend-modulemanager: ~2.2
- zendframework/zend-servicemanager: ~2.2
- zendframework/zend-stdlib: ~2.2
- zendframework/zend-view: ~2.2
Requires (Dev)
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~1.0
- zendframework/zendframework: ~2.2
This package is not auto-updated.
Last update: 2022-02-01 12:41:52 UTC
README
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.