joshuataylor/to-inline-style-email-bundle

A Symfony2 bundle for using the CssToInlineStyles translator by tijsverkoyen, this is a custom patched repository.

ToInlineStyleEmailBundle

ToInlineStyleEmailBundle is a Symfony2 bundle to use the CssToInlineStyles translator by _Tijs Verkoyen_ (see https://github.com/tijsverkoyen/CssToInlineStyles for the original repository), _(*1)

Requirements

ToInlineStyleEmailBundle is only supported on PHP 5.3.3 and up., _(*2)

Installation

Please, use the Composer to install this bundle in your Symfony2 app., _(*3)

The following lines should be added in your composer.json, _(*4)

"require": {
    "robertotru/to-inline-style-email-bundle": "dev-master"
},

Then, register the bundle in your AppKernel by adding the following line:, _(*5)

``` php new JoshTaylor\ToInlineStyleEmailBundle\JoshTaylorToInlineStyleEmailBundle(),, <sub>(*6)</sub>

Documentation and Examples
===========
The bundle provides a service named **css_to_inline_email_converter**. Use it in a controller to have a nice shortcut to the 
converter developed by _Tijs Verkoyen_. E.g.:

``` php
public function indexAction() { 
 $converter = $this->get('css_to_inline_email_converter');
 ...
}

Get the HTML and the CSS as a string and set this required values to the converter object, e.g., <sub>(*7)</sub>

``` php $converter = $this->get('css_to_inline_email_converter');, <sub>(*8)</sub>

$html = ...; // get the HTML here $css = ....; // get the CSS here, <sub>(*9)</sub>

$converter->setHTML($html); $converter->setCSS($css);, <sub>(*10)</sub>

The retrieval of the HTML and CSS files from its folder it is only up-to you. E.g. in your controller retrieve the content of your CSS as:

``` php
file_get_contents($this->container->getParameter('kernel.root_dir').
'/../src/Acme/TestBundle/Resources/css/mystyle.css');

Of course, it is supposed that a Symfony user will use a template instead of a static HTML page. Hence, for convenience, the service provides a function capable to render a template. E.g.:, <sub>(*11)</sub>

``` php $converter->setHTMLByView('AcmeTestBundle:MyController:my_template.html.twig', array('param_1'=>$val_of_param_1, ..., 'param_n'=>$val_of_param_n));, <sub>(*12)</sub>

The preceding function must be used _in vece_ of function ```setHTML()```.

You can use inline css directly in Twig template:

``` html
{% inlinecss '/css/email.css' %}
<div class="foo">
...
</div>
{% endinlinecss }

Paths relative to bundle are supported as well:, <sub>(*13)</sub>

html {% inlinecss '@AcmeBundle:css:email.css' %} <div class="foo"> ... </div> {% endinlinecss }, <sub>(*14)</sub>

Read the docs in the files for further details on the usage of the service., <sub>(*15)</sub>

Contributing

ToInlineStyleEmailBundle is an open source project. Contributions are encouraged. Feel free to contribute to improve this bundle., <sub>(*16)</sub>

About the author of the bundle

ToInlineStyleEmailBundle has been originally developed and is maintained by Roberto Trunfio (see more on the author at www.trunfio.it), <sub>(*17)</sub>

This unofficial branch is maintained by Josh Taylor until fixes are pushed upstream by the original author., <sub>(*18)</sub>