tangoman/callback-bundle

Callback Symfony Twig Extension Bundle

TangoMan Callback Twig Extension Bundle

TangoMan Callback Twig Extension Bundle provides simple callback manager for symfony projects., _(*1)

For example, anytime you need your users to fill a form from a paginated list, your controller will have to redirect them to the page they originated from and you don't want them to loose their parameters from query string., _(*2)

TangoMan Callback Twig Extension Bundle provides simple callback function for twig which avoids unnecessary callbacks to stack up indefinitely in users query string., _(*3)

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:, _(*4)

composer require tangoman/callback-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation., _(*5)

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:, _(*6)

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    // ...

    public function registerBundles()
    {
        $bundles = array(
            // ...
            new TangoMan\CallbackBundle\TangoManCallbackBundle(),
        );

        // ...
    }
}

You don't have to add TangoMan CallbackBundle to the service.yml of your project. twig.extension.callback service will load automatically., _(*7)

Usage

callback(route = null, parameters = [])

Returns current URI removing callback from query string. Optionally, returns the absolute URL (with scheme and host) for the given route with given parameters, callback will be ignored as well., _(*8)

Inside your views:, _(*9)

By default callback will be defined on user's current page., _(*10)

    <a href="{{ path('app_foo_bar', { 'callback': callback() }) }}">
        Your Foo Bar link here
    </a>

But you can optionally redirect user to any route., _(*11)

    <a href="{{ path('app_delete_foo', { 'callback': callback('app_trash_bin', { 'slug': 'foo' } ) }) }}">
        Your Foo Bar link here
    </a>

Callback function accepts route name and parameters for desired route., _(*12)

Inside your action method:, _(*13)

    public function foobarAction(Request $request)
    {
        ...
        // User is redirected to referrer page
        return $this->redirect($request->get('callback'));
        ...
    }

Tests

TangoMan CallbackBundle provides Makefile script to perform unit tests, in order to fit in your continuous integration workflow., _(*14)

Enter following command to install required dependencies and execute unit tests:, _(*15)

$ make tests

On windows machine you will need to install cygwin or GnuWin make first to execute make script., _(*16)

If you have XDebug installed, you can generate code coverage report with:, _(*17)

$ make coverage

Note

If you find any bug please report here : Issues, _(*18)

License

Copyright (c) 2018 Matthias Morin, _(*19)

Distributed under the MIT license., _(*20)

If you like TangoMan CallbackBundle please star! And follow me on GitHub: TangoMan75 ... And check my other cool projects., _(*21)

Matthias Morin | LinkedIn, _(*22)