|
|
sfJqueryReloadedPlugin - 1.2.4sfJqueryReloadedPlugin offers helpers that integrate the jQuery Javascript framework. |
|
The sfJqueryReloadedPlugin offers helpers that integrate the Jquery Javascript framework.
Please report all bugs to Fourat Zouari
This plugin is licensed under the MIT license. For the full copyright and license information, please view the LICENSE file that was distributed with this source code.
Jquery is offering an easy API, very well documented and can be a good replacement for the Prototype framework wich's used by default on symfony Javascript's helper.
And since Jquery comes with its powerfull JqueryUI to do effects easily, there's no need to implement scriptaculous.
The integration of sfJqueryPlugin is made simple, developers will have to use the new jQuery helper and prefix the old prototyped methods with jq_.
So the prototype method:
<?php echo link_to_remote(....);?>
will get this new Jquery form:
<?php echo jq_link_to_remote(....);?>
Install the plugin
$ symfony $ symfony plugin:install sfJqueryReloadedPlugin
Optional: change jquery_web_dir in setting.yml if you are not using the traditional symbolic link to the webdir of the plugin (or copying the plugin's /web folder to a folder called sfJqueryPlugin in your web dir, which will also work automatically with our defaults)
all:
.settings:
jquery_web_dir: /sfJqueryPlugin
Optional: within that folder's /js/ subfolder you might have a different version of jquery other than a minimized 1.3.1 which is what you currently get if you allow the plugin to supply it
all:
.settings:
jquery_core: jquery-1.3.1.min.js
Optional: specify different versions of the sortable and autocomplete plugins, which would be looked for in the /js/plugins/ subfolder of your jquery_web_dir
all:
.settings:
jquery_sortable: jquery-ui-sortable-1.6rc2.min.js
jquery_autocomplete: jquery.autocomplete-1.0.2.min.js
If you are under Microsoft Windows, you also have to manually copy the ./web
directory of the plugin in the %SF_ROOT_DIR%/web directory of your project
and rename it to sfJqueryReloadedPlugin.
Inside a template
In settings.yml, for all modules
standard_helpers: jQuery
To use Jquery methods, refer to Chapter 11 Ajax Integration, all helper functions described on the chapter can be used with the jq_ prefix.
Below are complete syntax for ready to use methods in the jQuery Helpers.
jq_periodically_call_remote($options = array())jq_link_to_function($name, $function, $html_options = array())jq_link_to_remote($name, $options = array(), $html_options = array())jq_update_element_function($element_id, $options = array())jq_form_remote_tag($options = array(), $options_html = array())jq_submit_to_remote($name, $value, $options = array(), $options_html = array())jq_javascript_tag($content)jq_visual_effect($effect, $element_id = false, $js_options = array()) jq_add_plugin($options = array() jq_sortable_element($selector, $options) (tom@punkave.com)These are the methods reconverted into jQuery functions till the sfJqueryPlugin last version. Future changes will integrate more functions.
http://trac.symfony-project.com/wiki/AjaxAndJSON#jsonwithoutheader and:
'@delete')),
'dataType' => 'json',
'success' => 'leaveGroup(request)')) ?>
sprintf for string manipulationImplement the rest of the Javascript Helper:
complete callback$ by jQueryjq_remote_function().jq_remote_function().method parameter and data serialisation in jq_remote_function.