Module: MetaTags::ControllerHelper

Defined in:
lib/meta_tags/controller_helper.rb,
sig/lib/meta_tags/controller_helper.rbs

Overview

Contains methods to use in controllers. You can define several instance variables to set meta tags:

@page_title = 'Member Login'
@page_description = 'Member login page.'
@page_keywords = 'Site, Login, Members' # legacy keywords tag

You can also use the #set_meta_tags method, which has the same parameters as ViewHelper#set_meta_tags.

Instance Method Summary collapse

Instance Method Details

#meta_tags ⇒ MetaTagsCollection

Get meta tags for the page.

Returns:



37
38
39
 
# File 'lib/meta_tags/controller_helper.rb', line 37

def meta_tags
  @meta_tags ||= MetaTagsCollection.new
end

#render(*args, &block) { ... } ⇒ void

This method returns an undefined value.

Processes the @page_title, @page_description, and legacy @page_keywords instance variables and calls render.

Parameters:

  • args (Array<Object>) —

    positional arguments forwarded to render.

  • block (Proc, nil) —

    optional block forwarded to render.

Yields:

  • optional block forwarded to render.

Yield Returns:

  • (Object) —

    result of the render block.



19
20
21
22
23
24
25
 
# File 'lib/meta_tags/controller_helper.rb', line 19

def render(*args, &block)
  meta_tags[:title] = @page_title if defined?(@page_title) && @page_title
  meta_tags[:keywords] = @page_keywords if defined?(@page_keywords) && @page_keywords
  meta_tags[:description] = @page_description if defined?(@page_description) && @page_description

  super
end

#set_meta_tags(meta_tags) ⇒ void

This method returns an undefined value.

Set meta tags for the page.

See MetaTags::ViewHelper#set_meta_tags for details.

Parameters:

  • meta_tags (Hash) —

    list of meta tags to merge into the page state.



31
32
33
 
# File 'lib/meta_tags/controller_helper.rb', line 31

def set_meta_tags(meta_tags)
  self.meta_tags.update(meta_tags)
end