Merge pull request #2 from EdgedesignCZ/feature/zd-366

User can define custom attributes

DependencyInjection/EdgeTexyExtension.php

@@ -3,26 +3,18 @@
 namespace Edge\TexyBundle\DependencyInjection;
 
 use Symfony\Component\Config\FileLocator;
-use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Texy;
 
 class EdgeTexyExtension extends Extension
 {
-
     public function load(array $configs, ContainerBuilder $container)
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('config.yml');
-
         $config = $this->mergeConfigs($configs);
-
-        if(array_key_exists('filters', $config)){
-            $managerDefinition = $container->getDefinition('edge_texy.manager');
-            $managerDefinition->addMethodCall('setDefinitions', array($config['filters']));
-        }
+        $this->updateParameters($config, $container);
     }
 
     /**
@@ -89,4 +81,14 @@ public function mergeConfigs(array $configs)
 
         return $config;
     }
+
+    public function updateParameters(array $config, ContainerBuilder $container)
+    {
+        $parameters = array('filters', 'custom_attributes');
+        foreach ($parameters as $param) {
+            if (array_key_exists($param, $config)) {
+                $container->setParameter("edge_texy.{$param}", $config[$param]);
+            }
+        }
+    }
 }

EdgeTexyBundle.php

@@ -4,9 +4,10 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
-/**
- * Edge texy bundle
- */
 class EdgeTexyBundle extends Bundle
 {
+    public function getContainerExtension()
+    {
+        return new DependencyInjection\EdgeTexyExtension();
+    }
 }

README.md

@@ -5,16 +5,22 @@ This is a simple bundle wrapping up Texy! text processor (http://texy.info/en) i
 
 ## Setup
 
-`composer require edgedesign/texy-bundle` should do the trick.
-
-Don't forget to register `Edge\TexyBundle\EdgeTexyBundle` in your AppKernel.
+1. `composer require edgedesign/texy-bundle`
+2. Add `new Edge\TexyBundle\EdgeTexyBundle()` to your AppKernel.
 
 ## Configuration
 
 Feel free to override `Resources/config/config.yml` directives.
 You can change classes which will be instantiated, if you are not satisfied with our implementation, 
 just implement correct interfaces please.
 
+### Custom attributes
+
+In section `edge_texy_bundle.custom_attributes` you can define custom html attributes which will
+be added to every html element. Useful for allowing html5 attributes (`download`, `data-something`, ...).
+
+### Filters
+
 In section `edge_texy_bundle.filters` you can set-up your filters.
 First-level key determines name of filter. 
 
@@ -31,7 +37,23 @@ If this settings is not enough, you can extend Texy, set it up in constructor an
 ```
 edge_texy_bundle.filters:
   filter_from_my_class:
-    class: MyClassExtendingTexy    			
+    # Name of class which will be used to instantiate Texy instance.
+    class: MyClassExtendingTexy   
+    # equivalent to $texy->allowed['block/code'] = FALSE;
+    allowed:
+        "block/code": false
+    # equivalent to $texy->allowedTags = array('a' => array('href', 'target'), 'em' => Texy::NONE, 'img' => Texy::ALL)
+    variables:
+        allowedTags:
+            a:
+               - href
+               - target
+            em: '-'
+            img: '*'
+    # equivalent to $texy->{name}Module->variable = value
+    modules:
+      link:
+          forceNoFollow: true; 			
 ```
 
 In this case, settings allowed, module and variables will be passed to this extended class too.
@@ -41,11 +63,18 @@ In this case, settings allowed, module and variables will be passed to this exte
 There are two ways how to use this bundle.
 
 ### Service
-You can get TexyProcessor service named `edge_texy_bundle.class.processor` and call method `$processor->process($filterId, $text)`.
+
+You can get TexyProcessor service named `edge_texy.processor` and call method
+
+```
+$processor->multiLineText($text, $filterId);
+$processor->singleLineText($text, $filterId);
+```
 
 This will process your `$text` via filter set in config with id `$filterId`.
 
-### Twig macros
+### Twig
+
 Second way is to use registered Twig macros '`texy_process`' and '`texy_process_line`'.
 
 ```twig
@@ -69,11 +98,14 @@ This way, given variable is passed through filter named `filterId`. If no filter
 
 Difference between macros is that when using texy_process_line, Texy will not wrap given code in block tags like <p>.
 
-### Settings examples
+### Example config.yml
+
 Settings example for sanitizing html output (put this into your config.yml):
 
 ```yaml
 edge_texy:
+  custom_attributes: &custom_attributes
+      500: download
   attribute_settings:
       html5_attributes: &html5_attributes
           100: itemid
@@ -86,6 +118,7 @@ edge_texy:
           201: id
       global_attributes: &global_attributes
           << : [*html5_attributes, *html_identifiers]
+          << : *custom_attributes
   filters:
       sanitize:
           allowed:
@@ -126,8 +159,3 @@ edge_texy:
 
 Now, you can use filter `sanitize` to sanitize your HTML output from user
 and filter `strip` to make user no HTML from user will appear in your code.
-## Tests
-
-Run tests with PHPUnit from root directory.
-
-No reasonable tests are done though. My bad..