method

remote_function

Ruby on Rails latest stable (v2.2.1) - 0 notes - Class: ActionView::Helpers::JavaScriptHelper

1.0.0 (0)
v1.1.0
v1.1.1
v1.1.2
v1.1.3
v1.1.4
v1.1.5
v1.1.6
v1.2.0
v1.2.1
v1.2.2
v1.2.3
v1.2.4
v1.2.5
v1.2.6
v2.0.0
v2.0.1
v2.0.2
v2.0.3
v2.1.0
v2.2.1
What's this?

Method deprecated

This method is deprecated on the latest stable version of Rails. The last existing version (v1.0.0) is shown here.

remote_function(options) public

Returns the javascript needed for a remote function. Takes the same arguments as link_to_remote.

Example:

  <select id="options" onchange="<%= remote_function(:update => "options", :url => { :action => :update_options }) %>">
    <option value="0">Hello</option>
    <option value="1">World</option>
  </select>

Show source

# File actionpack/lib/action_view/helpers/javascript_helper.rb, line 262
      def remote_function(options)
        javascript_options = options_for_ajax(options)

        update = ''
        if options[:update] and options[:update].is_a?Hash
          update  = []
          update << "success:'#{options[:update][:success]}'" if options[:update][:success]
          update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
          update  = '{' + update.join(',') + '}'
        elsif options[:update]
          update << "'#{options[:update]}'"
        end

        function = update.empty? ? 
          "new Ajax.Request(" :
          "new Ajax.Updater(#{update}, "

        function << "'#{url_for(options[:url])}'"
        function << ", #{javascript_options})"

        function = "#{options[:before]}; #{function}" if options[:before]
        function = "#{function}; #{options[:after]}"  if options[:after]
        function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
        function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]

        return function
      end

remote_function

Related methods

Method deprecated