Sha256: 3613debb999404292eafcd5fe931ac68caabd879c058e362ff606cb36fca184b

Contents?: true

Size: 1.15 KB

Versions: 22

Compression:

Stored size: 1.15 KB

Contents

module Alchemy
  module Hints
    # Returns a hint
    #
    # To add a hint to a content pass +hint: true+ to the element definition in its element.yml
    #
    # Then the hint itself is placed in the locale yml files.
    #
    # Alternativly you can pass the hint itself to the hint key.
    #
    # == Locale Example:
    #
    #   # elements.yml
    #   - name: headline
    #     contents:
    #     - name: headline
    #       type: EssenceText
    #       hint: true
    #
    #   # config/locales/de.yml
    #     de:
    #       content_hints:
    #         headline: Lorem ipsum
    #
    # == Hint Key Example:
    #
    #   - name: headline
    #     contents:
    #     - name: headline
    #       type: EssenceText
    #       hint: Lorem ipsum
    #
    # @return String
    #
    def hint
      hint = definition['hint']
      if hint == true
        Alchemy.t(name, scope: hint_translation_scope)
      else
        hint
      end
    end

    # Returns true if the element has a hint
    def has_hint?
      hint.present?
    end

    private

    def hint_translation_scope
      "#{self.class.model_name.to_s.demodulize.downcase}_hints"
    end
  end
end

Version data entries

22 entries across 22 versions & 1 rubygems

Version Path
alchemy_cms-3.6.7 lib/alchemy/hints.rb
alchemy_cms-3.6.6 lib/alchemy/hints.rb
alchemy_cms-3.6.5 lib/alchemy/hints.rb
alchemy_cms-3.6.4 lib/alchemy/hints.rb
alchemy_cms-3.6.3 lib/alchemy/hints.rb
alchemy_cms-3.6.2 lib/alchemy/hints.rb
alchemy_cms-3.6.1 lib/alchemy/hints.rb
alchemy_cms-4.0.0.beta lib/alchemy/hints.rb
alchemy_cms-3.6.0 lib/alchemy/hints.rb
alchemy_cms-3.5.0 lib/alchemy/hints.rb
alchemy_cms-3.4.2 lib/alchemy/hints.rb
alchemy_cms-3.5.0.rc2 lib/alchemy/hints.rb
alchemy_cms-3.5.0.rc1 lib/alchemy/hints.rb
alchemy_cms-3.4.1 lib/alchemy/hints.rb
alchemy_cms-3.3.3 lib/alchemy/hints.rb
alchemy_cms-3.3.2 lib/alchemy/hints.rb
alchemy_cms-3.4.0 lib/alchemy/hints.rb
alchemy_cms-3.4.0.rc1 lib/alchemy/hints.rb
alchemy_cms-3.3.1 lib/alchemy/hints.rb
alchemy_cms-3.3.0 lib/alchemy/hints.rb