README

Create and edit your global pages design in a wysiwyg fashion thanks to twitter boostrap framework

Installation

Add LayoutBundle by running the command:

$ php composer.phar require template_designer/layout_bundle "*"

then register the bundle with your kernel in 'app/AppKernel.php':

public function registerBundles()
{
    $bundles = array(
        // ...
        new TemplateDesigner\LayoutBundle\TemplateDesignerLayoutBundle(),
        // ...
    );

    // ...
}

Requirements:

• jquery (https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js)
• jquery ui (https://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/themes/smoothness/jquery-ui.css https://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js)
• twitter bootstrap V3 (http://getbootstrap.com/getting-started/#download)

None are included in the vendor

Configuration

Import all routes from the bundle

# app/config/routing.yml

template_designer_layout:
    resource: "@TemplateDesignerLayoutBundle/Controller/"
    type:     annotation
    prefix:   /

# app/config/config.yml

template_designer_layout:
    custom_param_template: # necessary to deal with include or render with parameters - example MyBundle:Default:customParams.html.twig
    data_collector_css:  
        main: # required / example : bundles/yourBundle/bootstrap/css/bootstrap.min.css
        #optional: # default null / other css if necessary
    # assetic : #default true
    # template_engine: #default bootstrap
    # base_twig : #from which to extend - default ::base.html.twig
    # class_configuration:
    #     layout_choice_form: #default TemplateDesigner\LayoutBundle\Form\LayoutEditionType
    #	  layout_edit_form : #default TemplateDesigner\LayoutBundle\Form\LayoutType

Do not forget to install assets

$ app/console assets:install web (--symlink)

Usage

##Routes:

• your url/layout to create templates
• your url/layout/edit to edit templates

##Step 1:

Create your first template and name it. Names are unique and will be the id of the template when we request it

Once you've created all the blocks in your template page, go to the edit route to assign static templates or render templates for one or more blocks. Should you need to give parameters to a block, you must give the block a custom parameters name as well as an include or a render in order to access the parameters later on.

##Step 2:

namespace YourProject\DefaultBundle\Controller;
#To display the page with your templates and blocks, you just have to call the annotation that will inject the layout entity (rootLayout) in your twig and wrap your parameters in an array parameter called 'params'

use TemplateDesigner\LayoutBundle\Annotation\LayoutAnnotation;
class DefaultController extends Controller
{
	/**
     * @Route("/hello/{name}")
     * @LayoutAnnotation(name="test")
     */
    public function indexAction($name)
    {
        return $this->render('YourProjectDefaultBundle:Default:index.html.twig',array('name'=>$name));
    }
}

In your twig template, you call the twig function with the injected layout entity and your parameters

{% block body %}
	{{render_layout(rootLayout.name,params)|raw}}
{% endblock %}

If you need to display only one block in your template, you can use the position of the block to reference it:

{% block body %}
    {{render_layout(rootLayout.name,params,2)|raw}}
{% endblock %}

You can choose not to display the container in your template:

{% block body %}
    {{render_layout(rootLayout.name,params,null,true)|raw}}
{% endblock %}

Two additionnal twig functions are available to display only the html tags with ids, classes but no content. As shown above, you can set a position to display exactly the block you wish:

{% block body %}
    {{layoutStart ($rootName,$position=null)}}
        content
    {{layoutEnd ($rootName,$position=null)}}
{% endblock %}

When you need to access a parameter inside a block, you can use the custom_param_template

{% if child.root.name == "test" and child.custom == "custom name" %}
	{% render(controller(child.render,{name:params['name']})) %}
{% endif %}

##Display Layout in toolbar If you need to see what content goes into which block, you can access the template design in the debug toolbar