class Marten::DB::Field::File

• Marten::DB::Field::File
• Marten::DB::Field::Base
• Reference
• Object

Overview

Represents a file field's value.

Instances of this class give access to the properties of a file manipulated by a file field. They allow to read a file's content, and to attach new files to model records.

Defined in:

Constructors

• .new(id : ::String, storage : Core::Storage::Base | Nil = nil, max_size : Int32 = 100, default : ::String | Nil = nil, upload_to : Proc(::String, ::String) | ::String = "", blank = false, null = false, unique = false, index = false, db_column = nil)

Instance Method Summary

• #default : String?

  Returns the default value of the field if any.

• #empty_value?(value) : ::Bool

  Returns true if the value is considered empty by the field.

• #from_db(value) : Marten::DB::Field::File::File | Nil

  Converts the raw DB value to the corresponding field value.

• #from_db_result_set(result_set : ::DB::ResultSet) : Marten::DB::Field::File::File | Nil

  Extracts the field value from a DB result set and returns the right object corresponding to this value.

• #max_size : Int32

  Returns the max size of the string corresponding to the file path to be stored in the database.

• #prepare_save(record, new_record = false)

  Runs pre-save logic for the specific field and record at hand.

• #sanitize_filename(filename : ::String) : ::String
• #storage

  Returns the storage object that should be used to store the file.

• #to_column : Management::Column::Base | Nil

  Returns a migration column object corresponding to the field at hand.

• #to_db(value) : ::DB::Any

  Converts the field value to the corresponding DB value.

• #upload_to : String -> String | String

  Returns the path where the file should be stored or a proc returning this path.

Constructor Detail

Instance Method Detail