Merge pull request #89 from marcelglaeser/develop

Make TicketBundle more adaptable with template paths in config

Author: hackzilla

Controller/TicketController.php

@@ -45,7 +45,7 @@ public function indexAction(Request $request)
         );
 
         return $this->render(
-            'HackzillaTicketBundle:Ticket:index.html.twig',
+            $this->container->getParameter('hackzilla_ticket.templates.index'),
             [
                 'pagination'     => $pagination,
                 'ticketState'    => $ticketState,
@@ -81,7 +81,7 @@ public function createAction(Request $request)
         }
 
         return $this->render(
-            'HackzillaTicketBundle:Ticket:new.html.twig',
+            $this->container->getParameter('hackzilla_ticket.templates.new'),
             [
                 'entity' => $ticket,
                 'form'   => $form->createView(),
@@ -100,7 +100,7 @@ public function newAction()
         $form = $this->createForm(TicketType::class, $entity);
 
         return $this->render(
-            'HackzillaTicketBundle:Ticket:new.html.twig',
+            $this->container->getParameter('hackzilla_ticket.templates.new'),
             [
                 'entity' => $entity,
                 'form'   => $form->createView(),
@@ -143,7 +143,7 @@ public function showAction($ticketId)
             $data['delete_form'] = $this->createDeleteForm($ticket->getId())->createView();
         }
 
-        return $this->render('HackzillaTicketBundle:Ticket:show.html.twig', $data);
+        return $this->render($this->container->getParameter('hackzilla_ticket.templates.show'), $data);
     }
 
     /**
@@ -190,7 +190,7 @@ public function replyAction(Request $request, $ticketId)
             $data['delete_form'] = $this->createDeleteForm($ticket->getId())->createView();
         }
 
-        return $this->render('HackzillaTicketBundle:Ticket:show.html.twig', $data);
+        return $this->render($this->container->getParameter('hackzilla_ticket.templates.show'), $data);
     }
 
     /**

DependencyInjection/Configuration.php

@@ -30,6 +30,18 @@ public function getConfigTreeBuilder()
                         ->booleanNode('attachment')->defaultTrue()
                     ->end()
                 ->end()
+                ->arrayNode('templates')
+                    ->addDefaultsIfNotSet()
+                    ->canBeUnset()
+                    ->children()
+                        ->scalarNode('index')->defaultValue('HackzillaTicketBundle:Ticket:index.html.twig')->end()
+                        ->scalarNode('new')->defaultValue('HackzillaTicketBundle:Ticket:new.html.twig')->end()
+                        ->scalarNode('prototype')->defaultValue('HackzillaTicketBundle:Ticket:prototype.html.twig')->end()
+                        ->scalarNode('show')->defaultValue('HackzillaTicketBundle:Ticket:show.html.twig')->end()
+                        ->scalarNode('show_attachment')->defaultValue('HackzillaTicketBundle:Ticket:show_attachment.html.twig')->end()
+                        ->scalarNode('macros')->defaultValue('HackzillaTicketBundle:Macros:macros.html.twig')->end()
+                    ->end()
+                ->end()
             ->end()
         ;
 

DependencyInjection/HackzillaTicketExtension.php

@@ -30,6 +30,13 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('hackzilla_ticket.model.message.class', $config['message_class']);
 
         $container->setParameter('hackzilla_ticket.features', $config['features']);
+        
+        $container->setParameter('hackzilla_ticket.templates.index', $config['templates']['index']);
+        $container->setParameter('hackzilla_ticket.templates.new', $config['templates']['new']);
+        $container->setParameter('hackzilla_ticket.templates.prototype', $config['templates']['prototype']);
+        $container->setParameter('hackzilla_ticket.templates.show', $config['templates']['show']);
+        $container->setParameter('hackzilla_ticket.templates.show_attachment', $config['templates']['show_attachment']);
+        $container->setParameter('hackzilla_ticket.templates.macros', $config['templates']['macros']);
     }
 
     public static function bundleDirectory()

README.md

@@ -53,6 +53,19 @@ These optional features that can be turned on or off.
 * [Custom Entities](Resources/doc/setup/feature/custom-entities.md)
 * [Events](Resources/doc/setup/feature/events.md)
 
+## Custom Templates (Optional)
+
+```
+config.yml
+
+hackzilla_ticket:
+    templates: 
+        index: 'YOURTicketBundle:Ticket:index.html.twig'
+        new: 'YOURTicketBundle:Ticket:new.html.twig'
+        prototype: 'YOURTicketBundle:Ticket:prototype.html.twig'
+        show: 'YOURTicketBundle:Ticket:show.html.twig'
+        show_attachment: 'YOURTicketBundle:Ticket:show_attachment.html.twig'
+```
 
 ## Migrate a Previous Version
 

Resources/config/services.yml

@@ -61,6 +61,13 @@ services:
             - '@hackzilla_ticket.features'
         tags:
             - { name: twig.extension }
+            
+    hackzilla_ticket.component.twig_extension.ticket_global:
+        class: Hackzilla\Bundle\TicketBundle\TwigExtension\TicketGlobalExtension
+        arguments:
+            - @service_container
+        tags:
+            - { name: twig.extension }
 
     hackzilla_ticket.file_upload_subscriber:
         class: Hackzilla\Bundle\TicketBundle\EventListener\FileSubscriber

Resources/views/Ticket/index.html.twig

@@ -1,5 +1,5 @@
 {% extends 'HackzillaTicketBundle::layout.html.twig' %}
-{% import 'HackzillaTicketBundle:Macros:macros.html.twig' as macros %}
+{% import hackzilla_ticket.templates.macros as macros %}
 
 {% block hackzilla_ticket_content -%}
     <h1>{{ 'HEADING_TICKET_LIST'|trans }}</h1>

Resources/views/Ticket/new.html.twig

@@ -14,9 +14,9 @@
             </div>
 
             {% if form.messages|length == 0 %}
-                {% include 'HackzillaTicketBundle:Ticket:prototype.html.twig' with {'form': form.messages.vars.prototype} %}
+                {% include hackzilla_ticket.templates.prototype with {'form': form.messages.vars.prototype} %}
             {% else %}
-                {% include 'HackzillaTicketBundle:Ticket:prototype.html.twig' with {'form': form.messages.__name__} %}
+                {% include hackzilla_ticket.templates.prototype with {'form': form.messages.__name__} %}
             {% endif %}
 
             {{ form_rest(form) }}

TwigExtension/TicketGlobalExtension.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Hackzilla\Bundle\TicketBundle\TwigExtension;
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class TicketGlobalExtension extends \Twig_Extension {
+
+    /**
+     *
+     * @access protected
+     * @var \Symfony\Component\DependencyInjection\ContainerInterface $container
+     */
+    protected $container;
+
+    /**
+     *
+     * @access public
+     * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
+     */
+    public function __construct(ContainerInterface $container) {
+        $this->container = $container;
+    }
+
+    /**
+     *
+     * @access public
+     * @return array
+     */
+    public function getGlobals() {
+        return array(
+            'hackzilla_ticket' => array(
+                'templates' => array(
+                    'index' => $this->container->getParameter('hackzilla_ticket.templates.index'),
+                    'new' => $this->container->getParameter('hackzilla_ticket.templates.new'),
+                    'show' => $this->container->getParameter('hackzilla_ticket.templates.show'),
+                    'show_attachment' => $this->container->getParameter('hackzilla_ticket.templates.show_attachment'),
+                    'prototype' => $this->container->getParameter('hackzilla_ticket.templates.prototype'),
+                    'macros' => $this->container->getParameter('hackzilla_ticket.templates.macros'),
+                ),
+            )
+        );
+    }
+
+    /**
+     *
+     * @access public
+     * @return string
+     */
+    public function getName() {
+        return 'ticketGlobal';
+    }
+
+}