manuelj555/ajax-flash-bundle

Symfony ManuelAjaxFlashBundle

Maintainers

Details

github.com/manuelj555/AjaxFlashBundle

Source

Issues

Installs: 434

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:symfony-bundle

1.0.1 2014-10-06 18:56 UTC

Requires

MIT 340a445062ae84a03fe41a3d811a9fecdfc1174b

javascriptbundleajaxflash

This package is auto-updated.

Last update: 2024-10-22 02:58:50 UTC

README

This Bundle Allow the Process of Flashes in ajax request via Javascript. Require jQuery.

Installation

Add to composer.json:

{
  "require": {
    "manuelj555/ajax-flash-bundle": "1.0.*@dev"
  }
}

Execute composer update.

Configuration

Register the bundle:

<?php
// app/AppKernel.php
public function registerBundles()
{
    return array(
        // ...
        new Manuelj555\Bundle\AjaxFlashBundle\ManuelAjaxFlashBundle(),
        // ...
    );
}

In the config.yml (All config is Optional):

manuel_ajax_flash:
    auto_assets:
        pnotify: ~
#        sticky: ~
    mapping:
#        success:
#            title: Información
#            icon: my-icon
#        info:
#            title: Información

auto_assets

Auto add the javascript and css in the html content. You have select the plugin to use, the available options are:

mapping

Allow set the title, icon and type for use in javascript, for each setted mapping type.

Example:

manuel_ajax_flash:
    mapping:
        success:
             type: success
             title: Información
             icon: my-icon
         info:
             type: info
             title: Información
         error:
             type: danger
             title: Error

Manual Assets Instalation

If you no enable the auto_assets config, you can use the twig view located in the bundle:

  • ManuelAjaxFlashBundle::pnotify.html.twig or
  • ManuelAjaxFlashBundle::sticky.html.twig

Example of use:

{% use 'ManuelAjaxFlashBundle::pnotify.html.twig' %}
{#{% use 'ManuelAjaxFlashBundle::sticky.html.twig' %}#}
<!DOCTYPE html>
<html>
    <head>
        ...
        
        {{ block('ajax_flash_css') }}
    </head>
    <body>
        ...
        
        {{ block('ajax_flash_js') }}
        {{ block('ajax_flash_plugin') }}
    </body>
</html>

Javascript Plugin

Usage:

$.ajaxFlash('*', function (message, type, title, icon) {
    //call on all flash types. this function is called for each flash message
    //the message parameter is a string
});
$.ajaxFlash('success info', function (message, type, title, icon) {
    //call on success and info flash types. this function is called for each flash message
    //the message parameter is a string
});
$.ajaxFlash('error', function (message, type, title, icon) {
    //call on error flash type. this function is called for each flash message
    //the message parameter is a string
});

// Working with array messages:

$.ajaxFlash(function (messages, type, title, icon) {
    //call in all flash types, this function is called one time for each message type.
    //the messages parameter is an array.
});

$.ajaxFlash(function (messages, type, title, icon) {
    //call success and info flash types, this function is called one time for each message type.
    //the messages parameter is an array.
}, 'success info');