kix/mdash-bundle

E. Muravjov's typographer for Symfony

0.5.2 2014-11-07 08:10 UTC

This package is auto-updated.

Last update: 2024-12-14 03:42:26 UTC


README

This is a Symfony 2 bundle for E. Muravjov's typograph.

Installation is simple. Just drop this line into your composer.json's require section:

"kix/mdash-bundle": "0.5.x"

Add the bundle into your AppKernel.php:

<?php
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
            // ...
            new \Kix\MdashBundle\KixMdashBundle(),
        );

After installing, a new mdash Twig filter will be available in your templates. It should be used as follows (let's assume that article object's text property contains text that needs proper formatting):

{{ article.text | mdash }}

Also, there's a kix_mdash.typographer service available that's an instance of \EMT\EMTypograph. You can always request it from the container and use it in any way you like:

<?php
class SomeClass implements ContainerAwareInterface
{

    public function processText()
    {
        /** @var \EMT\EMTypograph $typographer */
        $typographer = $this->container->get('kix_mdash.typographer');
    }

}

Stats

SensioLabsInsight

Build Status

Scrutinizer Code Quality