Module: CarrierWave::Uploader::Store
- Defined in:
- lib/carrierwave/uploader/store.rb
Instance Method Summary collapse
-
#filename ⇒ Object
Override this in your Uploader to change the filename.
-
#retrieve_from_store!(identifier) ⇒ Object
Retrieves the file from the storage.
-
#store!(new_file = nil) ⇒ Object
Stores the file by passing it to this Uploader’s storage engine.
-
#store_path(for_file = filename) ⇒ Object
Calculates the path where the file should be stored.
Instance Method Details
#filename ⇒ Object
Override this in your Uploader to change the filename.
Be careful using record ids as filenames. If the filename is stored in the database the record id will be nil when the filename is set. Don’t use record ids unless you understand this limitation.
Do not use the version_name in the filename, as it will prevent versions from being loaded correctly.
Returns
- String
-
a filename
25 26 27 |
# File 'lib/carrierwave/uploader/store.rb', line 25 def filename @filename end |
#retrieve_from_store!(identifier) ⇒ Object
Retrieves the file from the storage.
Parameters
- identifier (String)
-
uniquely identifies the file to retrieve
71 72 73 74 75 |
# File 'lib/carrierwave/uploader/store.rb', line 71 def retrieve_from_store!(identifier) with_callbacks(:retrieve_from_store, identifier) do @file = storage.retrieve!(identifier) end end |
#store!(new_file = nil) ⇒ Object
Stores the file by passing it to this Uploader’s storage engine.
If new_file is omitted, a previously cached file will be stored.
Parameters
- new_file (File, IOString, Tempfile)
-
any kind of file object
54 55 56 57 58 59 60 61 62 |
# File 'lib/carrierwave/uploader/store.rb', line 54 def store!(new_file=nil) cache!(new_file) if new_file if @file and @cache_id with_callbacks(:store, new_file) do @file = storage.store!(@file) @cache_id = nil end end end |
#store_path(for_file = filename) ⇒ Object
Calculates the path where the file should be stored. If for_file
is given, it will be used as the filename, otherwise CarrierWave::Uploader#filename is assumed.
Parameters
- for_file (String)
-
name of the file <optional>
Returns
- String
-
the store path
41 42 43 |
# File 'lib/carrierwave/uploader/store.rb', line 41 def store_path(for_file=filename) File.join(store_dir, full_filename(for_file)) end |