Module: UploaderHelper

Defined in:
app/helpers/uploader_helper.rb

Instance Method Summary collapse

Instance Method Details

#make_parent_params(parent) ⇒ Object 



92
93
94
95
 
# File 'app/helpers/uploader_helper.rb', line 92

def make_parent_params(parent)
  return {} if parent.blank?
  { :parent_id => parent.id, :parent_type => parent.class.to_s }
end

#new_upload_path_with_parent_information(upload_parent, format = 'js') ⇒ Object 



80
81
82
 
# File 'app/helpers/uploader_helper.rb', line 80

def new_upload_path_with_parent_information(upload_parent, format = 'js')
  multiupload_uploads_path({:format => format}.merge(make_parent_params(upload_parent)))
end

#new_upload_path_with_session_information(upload_parent, format = 'js') ⇒ Object 



76
77
78
 
# File 'app/helpers/uploader_helper.rb', line 76

def new_upload_path_with_session_information(upload_parent, format = 'js')
  multiupload_uploads_path({:format => format, :session_key => cookies[session_key], :request_forgery_protection_token => form_authenticity_token}.merge(make_parent_params(upload_parent)))
end

#session_key ⇒ Object 



84
85
86
87
88
89
90
 
# File 'app/helpers/uploader_helper.rb', line 84

def session_key
  if defined?(Rails.application)
    Rails.application.config.session_options[:key]
  else
    ActionController::Base.session_options[:key]
  end
end

#show_degraded_container_link ⇒ Object

Outputs a link that will show the degraded container. Use if users are having problems with the Flash uploader



98
99
100
 
# File 'app/helpers/uploader_helper.rb', line 98

def show_degraded_container_link
  %Q{<a class="show_degraded_container" href="#">#{I18n.t('uploader.show_degraded_container')}</a>}
end

#show_swfupload_container_link ⇒ Object

Outputs a link that will show the swfupload container



103
104
105
 
# File 'app/helpers/uploader_helper.rb', line 103

def show_swfupload_container_link
  %Q{<a class="show_swfupload_container" style="display:none;" href="#">#{I18n.t('uploader.show_swfupload_container')}</a>}
end

#upload_form(parent, display_upload_indicators = true, container_prefix = '', options = {}) ⇒ Object

Output a form capable of uploading files to the server using swfupload. parent: The object to which the uploads will be attached display_upload_indicators: Indicates whether or not to show the upload progress container_prefix: Prefixes each id in the html with the specified text. Useful if there is to be more than one form on a page. options: Options to pass to the swf javascript for setting up the swfupload object:

upload_url:             Url to upload to.  Default is '<%= new_upload_path_with_session_information(parent) %>'
file_size_limit:        Largest allowable file size.  Default is '100 MB'
file_types:             Allowed file types.  Default is "*.*"
file_types_description: Description for file types.  Default is "All Files"
file_upload_limit:      Maximum number of files per upload.  Default is 100
button_image_url:       Url of button image to use for swf upload.  Default is "/images/swfupload/SWFUploadButton.png"
button_width:           Width of the image button being used.  Default is 61
button_height:          Height of the button being used.  Default is 22
transparent:            Turns the swfupload transparent so you can use the html behind it for the upload button.  
                        This will override any settings provided for button_image_url
transparent_html:       If transparent is true this html will be rendered under the transparent swfupload button.



19
20
21
22
23
24
 
# File 'app/helpers/uploader_helper.rb', line 19

def upload_form(parent, display_upload_indicators = true, container_prefix = '', options = {})
  render :partial => 'uploads/swf_upload', :locals => {:parent => parent, 
                                                       :display_upload_indicators => display_upload_indicators, 
                                                       :container_prefix => container_prefix, 
                                                       :options => options}
end

#uploadify_form(parent, options = {}, uploadify_options = {}) ⇒ Object

Output a form capable of uploading multiple files to the server using uploadify. parent: The object to which the uploads will be attached options:

display_upload_indicators: Indicates whether or not to show the upload progress
container_prefix: Prefixes each id in the html with the specified text.  Useful if there is to be more than one form on a page.
format: either js or json. js will fire a callback.
omit_initializer: Remove the call to jQuery('#element').uploadify. If this is set to true the calling code 
                  must call .uploadify for the upload to work.

Options is a hash containing any valid option for uploadify:

http://www.uploadify.com/documentation/



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/helpers/uploader_helper.rb', line 36

def uploadify_form(parent, options = {}, uploadify_options = {})
  
  options = {
    :display_upload_indicators => true,
    :format => 'js',
    :omit_initializer =>  false
  }.merge(options)
  
  options[:container_prefix] = 'uploadify' if options[:container_prefix].blank?
  
  uploadify_options = {
        :uploader        => '/swf/uploadify.swf',
        :script          => multiupload_uploads_path({:format => options[:format]}),
        :cancelImg       => '/images/uploadify/cancel.png',
        :fileDesc        => "All Files",
        :fileExt         => "*.*",
        :auto            => true,
        :multi           => true,
        :buttonText      => 'Upload',
        :onComplete      => 'oncomplete_replace_',
        :scriptData      => {
          '_http_accept'       => 'application/javascript',
          '_method'            => 'post',
          "#{session_key}"     => 'session_key_replace_',
          'authenticity_token' => 'authenticity_token_replace_'
        }.merge(make_parent_params(parent))
    }.merge(uploadify_options)
    
  uploadify_options_json = uploadify_options.to_json
  # This is a bit of a hack but to_json will surround 'encodeURIComponent' with quotes so it won't execute. 
  # We need it to execute. The double encode is required - u on the server and encodeURIComponent on the client.
  uploadify_options_json.gsub!('"session_key_replace_"', "encodeURIComponent('#{u(cookies[session_key])}')")
  uploadify_options_json.gsub!('"authenticity_token_replace_"', "encodeURIComponent('#{u(form_authenticity_token)}')")
  uploadify_options_json.gsub!('"oncomplete_replace_"', 'function(event, queueID, fileObj, response, data){ upload_completed_callback(response); return true; }')
    
  render :partial => 'uploads/uploadify', :locals => { :parent => parent,
                                                        :options => options,
                                                        :uploadify_options => uploadify_options_json}
end