Method: ScrivitoHelper#scrivito_image_tag

Defined in:

app/helpers/scrivito_helper.rb

#scrivito_image_tag(obj, field_name_or_tag_options = nil, tag_or_editing_options = {}, editing_options = {}) ⇒ String

Note:

If you do not specify an HTML alt attribute, the helper method will use Obj#alt_description of the target object.

Calculates an HTML image tag of an image stored in the CMS for inplace editing.

Examples:

scrivito_image_tag(@obj, :my_linklist)
scrivito_image_tag(@obj, :my_linklist, alt: 'Interesting picture', class: 'my_image')
scrivito_image_tag(@obj, :my_linklist, {}, placeholder: image_path('my_placeholder.png'))
scrivito_image_tag(@obj, :my_linklist, {class: 'my_image'}, placeholder: 'http://placehold.it/350x150')

Render an image tag for a reference attribute.

scrivito_image_tag(@obj, :my_reference)

Render an image tag for a link attribute.

scrivito_image_tag(@obj, :my_link)

Render an image tag for a binary attribute

scrivito_image_tag(@obj, :my_binary)

Render an image tag for a binary Obj

scrivito_image_tag(@image)

Render an image tag with an on-the-fly calculated thumbnail

scrivito_image_tag @obj, :my_binary, {}, transform: {width: 50, height: 50}

Parameters:

• obj (Obj) —

  Obj with a link_list, reference, link or binary attribute

• field_name_or_tag_options (String, Symbol, Hash) (defaults to: nil) —

  Name of link_list, reference, link, or binary attribute, which contains the image or additional HTML attributes for the tag. The field_name can be omitted for binary Objs and blob will be used as default.

• tag_or_editing_options (Hash) (defaults to: {}) —

  Additional HTML attributes for the tag or the editing options if no field_name was given

• editing_options (Hash) (defaults to: {}) —

  Additional options for inplace editing

Options Hash (editing_options):

• :placeholder (String) — default: 'scrivito/image_placeholder.gif' —

  URL or path to image to be displayed if target is missing

• :transform (Hash) —

  if set, the displayed image will be transformed using the definition in the given hash, see Scrivito::Binary#transform.

Returns:

• (String) —

  HTML image tag

Raises:

• (ScrivitoError) —

  if field_name is not set and Obj is not binary

# File 'app/helpers/scrivito_helper.rb', line 188

def scrivito_image_tag(obj, field_name_or_tag_options=nil,
                       tag_or_editing_options = {}, editing_options = {})
  field_name, tag_options, editing_options =
    if field_name_or_tag_options.is_a?(Hash)
      [nil, field_name_or_tag_options, tag_or_editing_options]
    else
      [field_name_or_tag_options, tag_or_editing_options, editing_options]
    end

  if field_name.blank?
    if obj.binary?
      field_name = :blob
    else
      raise Scrivito::ScrivitoError,
          "when omitting `field_name' you have to pass a binary obj"
    end
  end

  options = Scrivito::ImageTag.new(self).options(obj, field_name,
      tag_options.with_indifferent_access, editing_options.with_indifferent_access)
  scrivito_tag('img', obj, field_name, options)
end