RRListView - a CListView extension to allow Ajax browser history

Yii 1.1 Tips, Snippets and Tutorials
8

Hi - I didn’t know we had limits on posts… - never mind.

I made a version of the JQuery extension with lots of console.logs to help you with debugging (attached below), but given what you’ve just said, I think the problem is simply where you unzipped the files - on my system, the directory structure in the compressed file is maintained - ie the RRListView.php file is in the extensions folder, then there is the sub-folder RRListView in the same extensions folder which contains the jquery.rr.yiilistview.js file (and where you should copy the files from /framework/zii/widgets/assets/listview, apart from jquery.yiilistview.js, in order to use the same images and things as with the original), so the RRListView.php folder should be in the extensions root, and the Javascript file in the RRListView sub-folder, not both in the same (we don’t want to publish the RRListView.php file as part of the assets).

So, to solve, simply delete the RRListView files you put there already, then unzip the compressed file directly in the extensions folder so that it puts the files in the right place:

extensions/RRListView.php

extensions/RRListView/jquery.rr.yiilistview.js

extensions/RRListView/[all the other CListView asset files]

If you want to use the (primitive) debugging version of the JQuery extension, simply unzip and copy the attached file over the extensions/RRListView/jquery.rr.yiilistview.js file - just remember to copy the original over it again when finished, because the debug uses "console.log", which will cause error in IE.

Hope everything works for you with this - let me know if not.

9

The limit is just for new users…

as there was to many SPAM "attacks" on this forum and the dev team could not be constantly online, we had to add some automatic SPAM preventions…

One of that is that a new registered user can post only 3 times on his first day, so that his posts (if SPAM) can be reviewed by the dev team…

10

Ok, thanks for the info.

11

I did like you said :

extensions/RRListView.php

extensions/RRListView/jquery.rr.yiilistview.js

extensions/RRListView/[all the other CListView asset files]

And it’s all working well, nice extension, very usefull!

Thank you ! :)

Manu

12

Glad it helped!

I’m actually working on a couple of things like this right now - like I said, I’ve also done a version of the CGridView widget (but haven’t yet implemented the filter part), and I’ve been doing other Ajax stuff such as automatic authorization redirection on timeouts etc, which I’ll try to make available when I’ve done.

13

Ok, here’s the latest (yet again improved) version.

There is an extension for both CListView and CGridView, and full hash history should be maintained for all pagination, filtering and sorting events. The actual hash monitoring logic is in a separate Javascript file (jquery.rr.hashhandling.js) which can also be used to attach hash history monitoring for other Ajax events of your own making (I’ll give more details on that later). If there is an Ajax error, there is an error handler which allows us to revert the hash to its previous state.

Once again, I advise you to copy the original CListView and CGridView assets into the assets folders of each of these extensions, in order to maintain the original look.

I have tested reasonably on my system and everything seems to work, however, I have not tested in different browsers (like IE) or different systems. Please let me know if you come across any bugs or have any cleaner ways of doing things.

Enjoy!

14

Hi i just came over this thread and tested your extension. Because I also wanted some feature to keep the sort + searchoptions on the gridview when using the browser back buttons.

Every thing is working BUT I find it quite strange.

If i access my page via this url disseminations/admin (dissminations is my controller, admin the action) I get the full gridview rendered.

If i then click a column to sort an ajax request is been done (disseminations/admin?sort=dissemination_type.desc&ajax=disseminations-grid) and the browser url is changed to disseminations/admin#sort=dissemination_type.desc. Through the ajax the gridview is beening sorted correctly.

So far so good. If I access the changed browser url (disseminations/admin#sort=dissemination_type.desc) in a new tab the normal gridview is been rendered through the admin action of the controller with the default sorting and an ajax done on pageload which requests the gridview again but this time sorted of the requested column.

So i have 2 times to render the gridview (one through the url request and one through the ajax load) and only the second one is showing the wanted results.

It comes even worse if i then have a filter set and reload / open the generated url in a new tab there where 2 ajax requests been done. So there a 3 requests where 2 requests aren’t show the correct results.

Is this normal? and if not what is wrong with my code? It would be very helpfull if you can upload some demo e.g. for the blog demo. Because currently I have no clue what could be wrong.

BTW i used the latest version you attached.

15

Hello!

I’m glad you’ve found it useful.

Yes, it is normal that you have multiple ajax loads if you access the hashed link in a new tab - as far as I know, the server will never be sent the hash part of the url (which is for links on the page only), so it can have no knowledge of the state given by the hash. Therefore it sends the normal page given by the url before the hash then, once loaded, the javascript kicks in, generates a hashchange event so that the hash part is checked, and then makes the appropriate ajax requests if it detects that the state given by the hash is not the same as the one given by the url before the hash.

This is therefore a necessary overhead (and you’ll find the same for any other javascript browser history plugins, unless they load everything on the one page and then hide it - in which case it is not true ajax anyway), and retains its utility on the basis that you will only have this overhead if you are using the link with hash from a fresh start - when using back and forward buttons it will not be an issue.

As for the extra ajax requests beyond the initial one, this is due to the fact that you can bind as many ajax handlers as you like, and the changes that they make to the page do not necessarily have to correspond to ajax requests to the base page, or correspond to the same options for that page. Therefore I don’t see any simple way to aggregate requests to the same page into one request without losing the independence between the different handlers.

So, it sounds like you are doing everything right, and the results you are getting are to be expected (I assume the pages are functioning as you want).

I must warn you that I haven’t had time to check the latest versions of the jquery.yiiGridView.js file and update mine appropriately so, although I think it should still work with the latest version, I don’t actually know.

Let me know if you have any more questions.

16

Thx for answer,

I guess i found some issue. I added the extension to the blog demo from yii and used the filter search.

With the normal gridview and search for the title="test post" i would find my post entry with "test post" in the title.

With your extension it will search for "test+post", this is also added as the filter value.

the ajax request url is wrong when a filter has some "spaces" used

With your extension:

/post/admin?Post[title]=test%2Bpost&Post[status]=&Post_page=1&ajax=yw0

with the normal grid

/post/admin?Post[title]=test+post&Post[status]=&ajax=yw0

the + seems to be escaped in the ajax request. Or the bbq url generation is, because when i change the hash url from

post/admin#Post[title]=test+post

to

post/admin#Post[title]=test%20post it will show the correct results.

17

Ok, thanks - that does sound like an issue. I’ll have a look at it when I get some time.

18

I had some time and tried some different approach, and implemented it directly in the jquery.yiigridview.js file.

And it works ;)

I limited the additional ajax request to only one which has to be done when a url with bbq url’s is pasted into a new browser window.

I tested also multiple gridview’s on one page as well as filter changes.

So far I can’t find no problems/bugs.

Currently the bqq usage for ajax requests is enabled by default. It can be changed via the settings which needs a public property in CGridview (need to be extended).

For testing just replace the original file in the asset folder.

rename the file to from .js.txt => .js (attachment was permitted).

Remarks are Welcome

regards Horizons

19

Ok, that’s good if it works for you.

The reason I had originally separated the hash handling from the gridview was so that other widgets or functions could also use the hash in the same way without having to have a hashchange handler for each one. In my logic a widget could initiate a hash change, and also pass a callback to be fired if needed (if one of its parameters were concerned), so that if a change in the hash happened which did not concern that particular widget we wouldn’t have to fire multiple hash change events anyway, and we wouldn’t have to duplicate code in checking whether the change concerned the widget.

20

If you try my modification it is exactly what you mean modifications in the #yw0 part of the url would make changes to the #yw0 widget only.

Just add 2 gridviews on the same page and test it out.

21

I was talking more about different widgets (or even custom ajax updates).

But I will certainly have a look and get back to you. Unfortunately I’m in the middle of a project at the moment so don’t have time to look yet.

22

Updated the gridview js file from yii version 1.1.7 with my bbq modifications.

Still no remarks or suggestions?

23

Sorry - I will get back to you - it’s just that at the moment I’m in the middle of a project that I need to finish.

24

Horizons i think your code is great. 1 last suggestion, please add the code to update the grid using the advance search form :)

25

@pcs2112 good to hear that my solution also works for others.

But i don’t understand your request because if i use the advanced search form on my site the gridview will get rendered correctly and after a successful ajax update the bbq url part is also correctly. And if i use the forward/backwards buttons of my browser the advanced search form options also get the values accordingly.

maybe some code example helps.




<?php


$basepath=Yii::app()->getBasePath();


Yii::app()->clientScript->registerScript('search', "

$('.search-button').click(function(){

	$('#search-form-outer').toggle();

	return false;

});

$('.search-form form').submit(function(){

	$.fn.yiiGridView.update('disseminations-grid', {

		data: $(this).serialize()

	});

	return false;

});

");

?>

<div style="margin:10px">

<?php

$searchform = CHtml::link('Advanced Search','#',array('class'=>'search-button'));

$searchform.='<div id="search-form-outer" style="display:none">';

$searchform.='<div id="search-form" class="search-form">';


$searchform.=$this->renderPartial('_search',array(

	'model'=>$model,

    'width'=>'600px'

),true);


$searchform.='</div><!-- search-form -->';  

$searchform.='</div>';


echo $searchform;




$absolute_url=Yii::app()->createAbsoluteUrl('//');

$updateSearchFormscript =<<<EOP


function updateSearchForm(id,result){

    $('.search-form form').submit(function(){

        $.fn.yiiGridView.update(id, {

            data: $(this).serialize()

        });

        return false;

    }); 

}


EOP;


Yii::app()->getClientScript()->registerScript('updateSearchForm',$updateSearchFormscript);


$export_links=CHtml::openTag('div',array('class'=>'exportbuttons'));

$export_links.=CHtml::Link('&nbsp;','',array('class'=>'excelexport tooltipleft','title'=>Yii::t('Global','Export to Excel'),'onclick'=>"location.replace($.param.querystring($.fn.yiiGridView.getUrl('disseminations-grid'),'export=1'));"));

$export_links.=CHtml::closeTag('div');


$pageSize=Yii::app()->user->getState('limit',Yii::app()->params['defaultPageSize']);

$pageSizeSelect=CHtml::openTag('div',array('class'=>'pageSizeSelect'));

$pageSizeSelect.=CHtml::Tag('span',array(),'Items per page:');

$pageSizeSelect.=CHtml::dropDownList('Disseminations[limit]',$pageSize,array(1=>1,5=>5,10=>10,20=>20,50=>50,100=>100),array(

'onchange'=>"$.fn.yiiGridView.update('disseminations-grid',{ data:{limit: $(this).val() }})",

));

$pageSizeSelect.=CHtml::closeTag('div');


$template="<div class='gridviewoptions'>{summary} $pageSizeSelect $export_links <br class=\"clearfloat\" /></div>\n{items}\n{pager}";


Yii::app()->user->setReturnUrl($this->createUrl('admin'));


$this->widget('zii.widgets.grid.CGridView', array(

	'id'=>'disseminations-grid',

	'dataProvider'=>$model->search(),

    'ajaxUpdate'=>'disseminations-grid,search-form',

    'afterAjaxUpdate'=>'updateSearchForm',

    'filter'=>$model,

    'cssFile'=>Yii::app()->baseUrl .'/css/grid2.css',

    'pager' => array('cssFile' => Yii::app()->baseUrl . '/css/grid2.css'),

    'filter'=>$model,

    'filterPosition'=>'body',

    'template' => $template,

	'columns'=>array(

    --- columns ---

	),

));


?>


</div>
26

awesome thanks for the reply your modification of the yiigridview works perfectly :). I added jquery blocking to make the loading of the grid similar to what you see in google when enterinf a new search or change the page.

27

I’m looking to enable back button with clistview… i think this will work but only for cgridview, not for clistview. Any planing for adding support for that widget?