Module: ActionView::ViewPaths::ClassMethods

Relationships & Source Files
Defined in:	actionview/lib/action_view/view_paths.rb

Instance Attribute Summary

#_view_paths rw
#_view_paths=(paths) rw
#view_paths rw

A list of all of the default view paths for this controller.
#view_paths=(paths) rw

Set the view paths.

Instance Method Summary

#append_view_path(path)

Append a path to the list of view paths for this controller.
#prepend_view_path(path)

Prepend a path to the list of view paths for this controller.
#local_prefixes private

Override this method in your controller if you want to change paths prefixes for finding views.
#_build_view_paths(paths) Internal use only
#_prefixes Internal use only

Instance Attribute Details

#_view_paths (rw)

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 15


def _view_paths
  ActionView::PathRegistry.get_view_paths(self)
end

#_view_paths=(paths) (rw)

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 19


def _view_paths=(paths)
  ActionView::PathRegistry.set_view_paths(self, paths)
end

#view_paths (rw)

A list of all of the default view paths for this controller.

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 59


def view_paths
  _view_paths
end

#view_paths=(paths) (rw)

Set the view paths.

Parameters

paths - If a ::ActionView::PathSet is provided, use that; otherwise, process the parameter into a PathSet.

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 68


def view_paths=(paths)
  self._view_paths = _build_view_paths(paths)
end

Instance Method Details

#_build_view_paths(paths)

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 31


def _build_view_paths(paths) # :nodoc:
  return paths if ActionView::PathSet === paths

  paths = ActionView::PathRegistry.cast_file_system_resolvers(paths)
  ActionView::PathSet.new(paths)
end

#_prefixes

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 23


def _prefixes # :nodoc:
  @_prefixes ||= begin
    return local_prefixes if superclass.abstract?

    local_prefixes + superclass._prefixes
  end
end

#append_view_path(path)

Append a path to the list of view paths for this controller.

Parameters

path - If a ::String is provided, it gets converted into the default view path. You may also provide a custom view path (see ActionView::PathSet for more information)

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 44


def append_view_path(path)
  self._view_paths = view_paths + _build_view_paths(path)
end

#local_prefixes (private)

Override this method in your controller if you want to change paths prefixes for finding views. Prefixes defined here will still be added to parents’ #_prefixes.

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 75


def local_prefixes
  [controller_path]
end

#prepend_view_path(path)

Prepend a path to the list of view paths for this controller.

Parameters

path - If a ::String is provided, it gets converted into the default view path. You may also provide a custom view path (see ActionView::PathSet for more information)

[ GitHub ]

# File 'actionview/lib/action_view/view_paths.rb', line 54


def prepend_view_path(path)
  self._view_paths = _build_view_paths(path) + view_paths
end