dropkick
v0.0.0

View Source Dropkick.Attachableer behaviour (dropkick v0.0.0)

This modules provides a definition to specialized uploaders that can be used to specify custom upload workflows. A specialized uploader acts as a hook before calling the function at Dropkick and allow you to modify how the upload is handled.

Link to this section Summary

Types

option()
transforms()

Callbacks

cache(upload, list)

See Dropkick.cache/2 for more information.

default_url(context)

Provide a default URL if no upload was found

filename(type, context)

Overrides the filename used when the attachment is stored. The original filename will still be kept as a metadata.

move(atch)

See Dropkick.move/2 for more information.

storage_prefix(type, context)

Defines the default prefix that will be used to store and retrieve uploads.

store(upload, list)

See Dropkick.store/2 for more information.

transforms(type, context)

Defines the transformations to be applied after saving attachments.

validate(type, context)

Defines a series of validations that will be called before caching the attachment.

Functions

using(opts)

Link to this section Types

Link to this type

option()

View Source 
@type option() :: {atom(), any()}
Link to this type

transforms()

View Source 
@type transforms() ::
  :noaction
  | {:blur, list()}
  | {:resize, float(), list()}
  | {:thumbnail, pos_integer() | String.t(), list()}

Link to this section Callbacks

Link to this callback

cache(upload, list)

View Source 
@callback cache(upload :: Dropkick.Upload.t(), list()) :: Dropkick.Attachment.type()

See Dropkick.cache/2 for more information.

Link to this callback

default_url(context)

View Source 
@callback default_url(context :: map()) :: String.t()

Provide a default URL if no upload was found

Link to this callback

filename(type, context)

View Source 
@callback filename(Dropkick.Attachment.type(), context :: map()) :: String.t()

Overrides the filename used when the attachment is stored. The original filename will still be kept as a metadata.

Link to this callback

move(atch)

View Source 
@callback move(atch :: Dropkick.Attachment.t()) :: Dropkick.Attachment.type()

See Dropkick.move/2 for more information.

Link to this callback

storage_prefix(type, context)

View Source 
@callback storage_prefix(Dropkick.Attachment.type(), context :: map()) :: String.t()

Defines the default prefix that will be used to store and retrieve uploads.

Link to this callback

store(upload, list)

View Source 
@callback store(upload :: Dropkick.Upload.t(), list()) :: Dropkick.Attachment.type()

See Dropkick.store/2 for more information.

Link to this callback

transforms(type, context)

View Source 
@callback transforms(Dropkick.Attachment.type(), context :: map()) :: transforms()

Defines the transformations to be applied after saving attachments.

Link to this callback

validate(type, context)

View Source 
@callback validate(Dropkick.Attachment.type(), context :: map()) ::
  :ok | {:error, String.t()}

Defines a series of validations that will be called before caching the attachment.

Link to this section Functions

Link to this macro

using(opts)

View Source (macro)