symfony-bundle jquery-ajax-enx-bundle

analyzer666/jquery-ajax-enx-bundle

This bundle provides a Twig functions that generate js function to send ajax request.

JQueryAjaxBundleEnx for Symfony2. fork of mabs/jquery-ajax-bundle, _(*1)

Install

To install this bundle on your project, add this line to composer.json file:, _(*2)

json
"analyzer666/jquery-ajax-bundle-enx": "dev-master"

How to use:, _(*3)

Prepare to use Ajax..., _(*4)

On client side:

1) Twig: Making some div which will show before ajax request is go on the server and will hiding after get respone:, _(*5)

<div id="ajax-loading">
   <img src="{{ asset('bundles/app/images/ajax-loading.gif') }}" class="ajax-loader">
 </div>

2) Twig: Adding div to update data. Content of this div will be replaced by returned data, _(*6)

<div id="galleries" class="col-sm-12 col-md-12"></div>

3) CSS: Adding CSS styles to this div, _(*7)

#ajax-loading {  
    position:   fixed;
    z-index:    1000;
    top:        0;
    left:       0;
    height:     100%;
    width:      100%;
    background-color:#c5523f;
    opacity: .8;
    display: none;
}

.ajax-loader {
    position: absolute;
    left: 50%;
    top: 50%;
    margin-left: -32px; /* -1 * image width / 2 */
    margin-top: -32px;  /* -1 * image height / 2 */
    display: block;     
}

Thats all preparing for client side., _(*8)

On server side:

1) Controller: Making controller to get response, _(*9)

/**
* @Route("/gallery/get/galleries/{category_id}", name="gallery_renderGalleries")
*/
public function getGalleriesAction($category_id = null)
{
    $selectedCategory = $this->getDoctrine()
        ->getRepository('AppBundle:GalleryCategory')
        ->findOneById($category_id)
    ;
    $galleries = $selectedCategory->getGalleries();
    if (count($galleries)>1) {
        return $this->render(
            'default/gallery/render_galleries.html.twig', 
            array(
                'selectedCategory' => $selectedCategory,
            )
        );
    } elseif (count($galleries)==1) {
       return $this->getGalleryPhotosAction($galleries->first()->getId());
    }
}

Thats all for server part., _(*10)

Lets use Ajax! Just insert into the twig this code:, _(*11)

{{ ja_link({
    'update': '#galleries', 
    'url': url('gallery_renderGalleries', {'category_id':category.id}), 
    'text': 'Gallery',
    'after': set_after,
    'loading': '#ajax-loading'
}) }}

this code get us working link to send ajax request., _(*12)

<a href="http://127.0.0.1/aorig/app_dev.php/gallery/get/galleries/1"
    onclick="$.ajax({
    url: 'http://127.0.0.1/aorig/app_dev.php/gallery/get/galleries/1',
    type: 'POST',
    dataType: 'html',
    beforeSend: function(){$('#ajax-loading').show(); },
    success: function( data ){ 
        $('#galleries').html(data); 
        $('#ajax-loading').hide(); }
    }); return false;">PhotoGallery</a>`

This wirking example of using this plagin., _(*13)

This bundle add 3 Twig functions:, _(*14)

1 - ja_request:

To generate a js code to send an ajax request:, _(*15)

1) twig, _(*16)

{{ ja_request({'update': '#reponse', 'url': path('new')  }) }}

or, _(*17)

{{ ja_request({
    'update': '#reponse', 
    'url': path('new'), 
    'after': 'alert("after");', 
    'before': 'alert("before");', 
    'complete': 'alert("complete");'  }) 
}}

=> html, _(*18)

$.ajax({ 
    url: "/app_dev.php/new", 
    type: "POST", 
    dataType: "html",
    beforeSend: function(){alert("before");},
    success: function( data ){$( "#reponse" ).html(data);alert("after");}
});

Options for jQuery ajax request:, _(*19)

*    -$options['type']          : type: '...'; default - POST
*    -$options['dataType']      : dataType: '$dataType'; default - html 
*    +$options['url']           : url: "..."
*    -$options['before']        : beforeSend: function(){"..."}
*    +$options['update']        : success: function( data ){"...").html(data)
*    -$options['after']         : adding to the end of success:
*    -$options['complete']      : complete: function(){"..."}
*    -$options['loading']       : div id to show and hideand hide

2 - ja_link:

To generate a link:, _(*20)

twig, _(*21)

{{ ja_link({'update': '#reponse', 'url': path('new'), 'text': 'new link'  }) }}`

To add a confirm action on click, you just have to use 'confirm': true, by default the text is "Are you sure you want to perform this action?" then if you want to replace it, use 'confirm_msg': "***"., _(*22)

You can also use those parameters 'before' and 'after' to execute JS code. Lets upderstand all options:, _(*23)

Options for link (/) element:, _(*24)

*   -$options['confirm']        : true-false:
*   -$options['confirm_msg']    : message to confirm ajax request
*   -$options['class']          : <a class="..."
*   -$options['id']             : <a id="..."
*   +$options['href']           : <a href="..."
*   +$options['text']           : <a>...</a>

=>, _(*25)

{{ ja_link({
    'update': '#photos', 
    'url': url('gallery_renderGalleryPhotos', {'gallery_id':gallery.id}), 
    'text': gallery.name,
    'after': unitegallery_function,
    'loading': 'ajax-loading'
}) }}

3 - ja_button

Options of button elements:, _(*26)

*   -$options['confirm']        : true-false:
*   -$options['confirm_msg']    : message to confirm request
*   -$options['class']          : <button class="..."
*   -$options['id']             : <button id="..."
*   -$options['type']           : <button type="..."
*   -$options['data-toggle']    : <button data-toggle="..."
*   -$options['data-target']    : <button data-target="..."
*   -$options['data-dismiss']   : <button data-dismiss="..."
*   -$options['aria-label']     : <button aria-label="..."
*   +$options['text']           : <button>...</button>
*   -$options['data']           : data: ...; 
    $(this.form.elements).serializeArray() for form submit

jQuery options same like in ja_link function:, _(*27)

License

This bundle is available under the MIT license., _(*28)