Class: CarrierWave::Uploader::Base

Inherits:
Object
  • Object
show all
Includes:
Cache, Callbacks, Configuration, ContentTypeBlacklist, ContentTypeWhitelist, DefaultUrl, Download, ExtensionBlacklist, ExtensionWhitelist, FileSize, Mountable, Processing, Proxy, Remove, Serialization, Store, Url, Versions
Defined in:
lib/carrierwave/uploader.rb

Overview

An uploader is a class that allows you to easily handle the caching and storage of uploaded files. Please refer to the README for configuration options.

Once you have an uploader you can use it in isolation:

my_uploader = MyUploader.new
my_uploader.cache!(File.open(path_to_file))
my_uploader.retrieve_from_store!('monkey.png')

Alternatively, you can mount it on an ORM or other persistence layer, with CarrierWave::Mount#mount_uploader. There are extensions for activerecord and datamapper these are very simple (they are only a dozen lines of code), so adding your own should be trivial.

Constant Summary

Constants included from CarrierWave::Utilities::Uri

CarrierWave::Utilities::Uri::SAFE_STRING, CarrierWave::Utilities::Uri::UNSAFE

Instance Attribute Summary collapse

Attributes included from Mountable

#model, #mounted_as

Class Method Summary collapse

Methods included from Serialization

#as_json, #serializable_hash, #to_json, #to_xml

Methods included from DefaultUrl

#default_url, #url

Methods included from Versions

#recreate_versions!, #url, #version_exists?, #version_name, #versions

Methods included from Callbacks

#with_callbacks

Methods included from Processing

#process!

Methods included from FileSize

#size_range

Methods included from ContentTypeBlacklist

#content_type_blacklist

Methods included from ContentTypeWhitelist

#content_type_whitelist

Methods included from ExtensionBlacklist

#extension_blacklist

Methods included from ExtensionWhitelist

#extension_whitelist

Methods included from Remove

#remove!

Methods included from Download

#download!, #process_uri

Methods included from Cache

#cache!, #cache_name, #cache_path, #cache_stored_file!, #cached?, #retrieve_from_cache!, #sanitized_file

Methods included from Store

#filename, #retrieve_from_store!, #store!, #store_path

Methods included from Mountable

#initialize

Methods included from Url

#to_s, #url

Methods included from Proxy

#blank?, #content_type, #current_path, #identifier, #length, #read, #size

Instance Attribute Details

#file ⇒ Object (readonly)

Returns the value of attribute file.



44
45
46
 
# File 'lib/carrierwave/uploader.rb', line 44

def file
  @file
end

Class Method Details

.singleton_class? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/carrierwave/uploader.rb', line 50

def self.singleton_class?
  !ancestors.include? self
end