blast-project/utils-bundle

All kinds of goodies for the BlastCoreBundle

Friday, March 16, 2018
by beta
Repository
3 Watchers
1 Stars
5,359 Installations

PHP
8 Dependents
0 Suggesters
0 Forks
0 Open issues
15 Versions
0 % Grown

The README.md

Blast UtilsBundle

, _(*1)

, _(*2)

Features

Blast Choices

Documentation to be writen, _(*3)

Blast Hooks

This bundle introduce a hook feature that is really basic hook management., _(*4)

You can define in your views any hook you want., _(*5)

Declare the hook target location in a view

{# myTemplate.html.twig #}




    Here my custom hook
    {{ blast_hook('my.custom.hook', {'someParameters': myVar}) }}

A hook can be declared without using any parameters. If so, the « hook block » won't have any parameters defined in handleParameters's method parameter (var $hookParameters will be an empty array)., _(*6)

Declare your Hook class

This class will manage rendering of the hook content by setting view parameters (act as a controller), _(*7)

<?php

namespace MyBundle\Hook\MyCustomHook;

use Blast\UtilsBundle\Hook\AbstractHook;

class MyCustomHookExample extends AbstractHook
{
    protected $hookName = 'my.custom.hook';
    protected $template = 'MyBundle:Hook:my_custom_hook_example.html.twig';

    public function handleParameters($hookParameters)
    {
        $this->templateParameters = [
            'someViewParameter' => 'a value that will be passed to the twig view'
        ];
    }
}

Note: you can get the current hook name (configured in service definition) in attribute AbstractHook::hookName ans the configured template in AbstractHook::template, _(*8)

Register the hook class as service

    my_bundle.hook.my_custom_hook_example:
        class: MyBundle\Hook\MyCustomHook\MyCustomHookExample
        tags:
            - { name: blast.hook, hook: my.custom.hook, template: MyBundle:Hook:my_custom_hook_example.html.twig }

The hook configuration are sets in the service tag : - name: the service tag name (must be blast.hook) - hook: the target hook where the « block » will be rendered - template: the twig template of the « block », _(*9)

Please don't forget the tag blast.hook in order to register your service as a hook, _(*10)

Create your hook template

{# MyBundle:Hook:my_custom_hook_example.html.twig #}




    Here's my first custom hook,  with a view var : {{ someViewParameter }} !
, _(*11)

And voila, you should have this rendered content :, _(*12)

<div>
    <h1>Here my custom hook</h1>
    <p>
        Here's my first custom hook,  with a view var : a value that will be passed to the twig view !
    </p>
</div>

Blast Custom Filters

Enable the feature in config.yml, _(*13)

# app/config/config.yml
blast_utils:
    features:
        customFilters:
            enabled: true

Optionnaly, you can define your own customFilter entity by setting it as below (don't forget to set the associated repository in order to override createNewCustomFilter method) :, _(*14)

# app/config/config.yml
blast_utils:
    features:
        customFilters:
            enabled: true
            class: MyBundle\Entity\MyCustomFilter

You only have to set your User class entity in application config.yml (see https://symfony.com/doc/current/doctrine/resolve_target_entity.html for more informations), _(*15)

# app/config/config.yml
doctrine:
    # ...
    orm:
        # ...
        resolve_target_entities:
            Blast\CoreBundle\Model\UserInterface: MyBundle\Entity\MyUser

If you're using Sylius, setting the doctrine.orm resolve_target_entities key will not work because Sylius is already using this system. You can declare your Interface / Entity replacement within SyliusResource configuration :, _(*16)

# app/config/config.yml
sylius_resource:
    resources:
        blast.utils: # this is an arbitrary key
            classes:
                model: MyBundle\Entity\MyUser
                interface: Blast\CoreBundle\Model\UserInterface

Blast User Interface

In order to set User mapping with utils entity, the mapping with Interface is used., _(*17)

There are 2 ways for configuring the real class that will replace the UserInterface :, _(*18)

Using Sylius

declare, via resources, the class that will replace the model interface, _(*19)

sylius_resource:
    resources:
        blast.utils:
            classes:
                model: MyBundle\Entity\MyRealUser
                interface: Blast\CoreBundle\Model\UserInterface

Using Syfony's Doctrine target entity resolver :

doctrine:
    # ...
    orm:
        #...
        resolve_target_entities:
            Blast\CoreBundle\Model\UserInterface: MyBundle\Entity\MyRealUser

The Versions

16/03 2018

dev-wip-platform

dev-wip-platform https://github.com/blast-project/UtilsBundle

All kinds of goodies for the BlastCoreBundle

symfony-bundle utils-bundle

All kinds of goodies for the BlastCoreBundle

blast-project/utils-bundle

The README.md

Blast UtilsBundle

Features

Blast Choices

Blast Hooks

Declare the hook target location in a view

Here my custom hook

Declare your Hook class

Register the hook class as service

Create your hook template

Blast Custom Filters

Blast User Interface

Using Sylius

Using Syfony's Doctrine target entity resolver :

The Versions

dev-wip-platform

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

dev-wip-lisem

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

dev-master

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

0.6.4

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

0.5.2

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

dev-wip-locale

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

0.5.1

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

dev-wip-test

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ

by Marcos Bezerra de Menezes

0.4.5

The Requires

The Development Requires

by Baptiste SIMON

by Libre Informatique

by Romain SANCHEZ