Skip to content

Latest commit

 

History

History
126 lines (91 loc) · 3.84 KB

blocks.md

File metadata and controls

126 lines (91 loc) · 3.84 KB
Raw
layout title toc body_class
doc
The block System
true
body-pink

How to create a new kind of block

Run the symfony command : bin/console make:block sample (write name of block in lower case)

This will generate the service block and the twig template sample

In the service you have to implements :

  • execute(Block $block) : array to return the twig variables needed for template this is the block controller
  • getType() : string the type of block for db stored name
  • createAdminConfigurationForm(FormBuilderInterface $builder) the configurable part of your bundle
  • configure(NodeDefinition $rootNode) to configure the configuration of your block

The execute method

The execute method define the variables that can be used in the template. You can use this as a Controller

public function execute(Block $block) : array
{
    return [
        'article' => $this->requestStack->getCurrentRequest()->get('article'),
    ];
}

The $block is automatically also passed inside your template to give you the way to get the current block instance.

With the given example in your twig you can use

dump(article) - To get the article
dump(block.configuration) - To get the article configuration

The getType method

This method have to return one unique name that is the identifier of your block inside the database. This will also be the translation key for your block to have one human name inside the backend.

public function getType() : string
{
    return 'article';
}

The createAdminConfigurationForm(FormBuilderInterface $builder)

Sometime, your block require configuration, that means it does not just use the request context but for example have to be filtered on one category. So to build your execute you need to get some user defined configuration.

To do that, just configure the admin form with :

use Opera\CoreBundle\Form\Type\CkEditorOrTextareaType;
use Symfony\Component\Form\FormBuilderInterface;

public function createAdminConfigurationForm(FormBuilderInterface $builder)
{
    $builder->add('text', CkEditorOrTextareaType::class);    
}

You can use all of the symfony form types and all of this configuration will be persisted inside $block->getConfiguration()

The configure(NodeDefinition $rootNode) method

You can configure the configuration of your block so that some default values of your block config are set.

use Symfony\Component\Config\Definition\Builder\NodeDefinition;

public function configure(NodeDefinition $rootNode)
{
    /**
     * We set 'Lorem ipsum' as default value for the 'text' admin configuration form
     */
    $rootNode
        ->children()
            ->scalarNode('text')->defaultValue('Lorem ipsum')->end()
        ->end();
}

Define a custom template

By default the getTemplate return sprintf('blocks/%s.html.twig', $this->getType()); so the template is something like templates/blocks/article.html.twig

Just override : getTemplate(Block $block)

For example if you want a template that depend of configuration :

use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Opera\CoreBundle\Entity\Block;

public function createAdminConfigurationForm(FormBuilderInterface $builder)
{
    $builder->add('template', ChoiceType::class, [
        'choices' => [
            'Super template' => 'example.html.twig',
            'Super template 2' => 'example2.html.twig',
        ],
    ]);    
}

public function getTemplate(Block $block)
{
    return sprintf('blocks/my-block/%s', $block->getConfiguration()['template']);    
}

Related