Reset the template root based on the @_template_root ivar.
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 203 def self._reset_template_roots self.template_roots = [[self._template_root, :_template_location]] end
Resets the template roots to the template root passed in.
root<~to_s> |
The new path to set the template root to. |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 195 def self._template_root=(root) @_template_root = root _reset_template_roots end
Adds a filter to the after filter chain
filter<Symbol, Proc> |
The filter to add. Defaults to nil. |
opts<Hash> |
Filter options (see class documentation under Filter Options). |
&block |
A block to use as a filter if filter is nil. |
If the filter already exists, its options will be replaced with opts.;
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 446 def self.after(filter = nil, opts = {}, &block) add_filter(self._after_filters, filter || block, opts) end
Adds a filter to the before filter chain.
filter<Symbol, Proc> |
The filter to add. Defaults to nil. |
opts<Hash> |
Filter options (see class documentation under Filter Options). |
&block |
A block to use as a filter if filter is nil. |
If the filter already exists, its options will be replaced with opts.
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 462 def self.before(filter = nil, opts = {}, &block) add_filter(self._before_filters, filter || block, opts) end
The controller name in path form, e.g. "admin/items". |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 132 def self.controller_name() @controller_name ||= self.name.to_const_path end
klass<Merb::AbstractController> |
The controller that is being inherited from Merb::AbstractController |
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 241 def self.inherited(klass) _abstract_subclasses << klass.to_s helper_module_name = klass.to_s =~ /^(#|Merb::)/ ? "#{klass}Helper" : "Merb::#{klass}Helper" # support for unnamed module like "#<Class:0xa2e5e50>::TestController" helper_module_name.gsub!(/(::)|[:#<>]/, "\\1") Object.make_module helper_module_name klass.class_eval include Object.full_const_get("#{helper_module_name}") rescue nil super end
This will initialize the controller, it is designed to be overridden in subclasses (like MerbController)
*args |
The args are ignored in this class, but we need this so that subclassed initializes can have parameters |
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 259 def initialize(*args) @_benchmarks = {} @_caught_content = {} end
Removes a filter from the after filter chain. This removes the filter from the filter chain for the whole controller and does not take any options.
filter<Symbol, String> |
A filter name to skip. |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 474 def self.skip_after(filter) skip_filter(self._after_filters, filter) end
Removes a filter from the before filter chain. This removes the filter from the filter chain for the whole controller and does not take any options.
filter<Symbol, String> |
A filter name to skip. |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 486 def self.skip_before(filter) skip_filter(self._before_filters , filter) end
Returns the list of classes that have specifically subclassed AbstractController. Does not include all decendents.
Set |
The subclasses. |
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 234 def self.subclasses_list() _abstract_subclasses end
The location to look for a template - override this method for particular behaviour.
template<String> |
The absolute path to a template - without template extension. |
type<~to_s> |
The mime-type of the template that will be rendered. Defaults to being called with nil. |
:api: public @overridable
# File lib/merb-core/controller/abstract_controller.rb, line 184 def _absolute_template_location(template, type) template end
This method exists to provide an overridable hook for ActionArgs. It uses send to call the action method.
action<~to_s> |
the action method to dispatch to |
:api: plugin @overridable
# File lib/merb-core/controller/abstract_controller.rb, line 320 def _call_action(action) send(action) end
Determine whether the filter should be called for the current action using :only and :exclude.
rule<Hash> |
Rules for the filter (see below). |
action_name<~to_s> |
The name of the action to be called. |
:only<Array> |
Optional list of actions to fire. If given, action_name must be a part of it for this function to return true. |
:exclude<Array> |
Optional list of actions not to fire. If given, action_name must not be a part of it for this function to return true. |
Boolean |
True if the action should be called. |
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 379 def _call_filter_for_action?(rule, action_name) # Both: # * no :only or the current action is in the :only list # * no :exclude or the current action is not in the :exclude list (!rule.key?(:only) || rule[:only].include?(action_name)) && (!rule.key?(:exclude) || !rule[:exclude].include?(action_name)) end
Calls a filter chain.
A set of filters in the form [[:filter, rule], [:filter, rule]] |
Symbol |
:filter_chain_completed. |
Filter rules can be Symbols, Strings, or Procs.
Symbols or Strings |
Call the method represented by the Symbol or String. |
Procs |
Execute the Proc, in the context of the controller (self will be the controller) |
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 343 def _call_filters(filter_set) (filter_set || []).each do |filter, rule| if _call_filter_for_action?(rule, action_name) && _filter_condition_met?(rule) case filter when Symbol, String if rule.key?(:with) args = rule[:with] send(filter, *args) else send(filter) end when Proc then self.instance_eval(&filter) end end end return :filter_chain_completed end
This will dispatch the request, calling internal before/after dispatch callbacks. If the return value of _call_filters is not :filter_chain_completed the action is not called, and the return from the filters is used instead.
action<~to_s> |
The action to dispatch to. This will be send'ed in _call_action. Defaults to :to_s. |
<~to_s> |
Returns the string that was returned from the action. |
ArgumentError |
Invalid result caught from before filters. |
:api: plugin
# File lib/merb-core/controller/abstract_controller.rb, line 280 def _dispatch(action) self.action_name = action self._before_dispatch_callbacks.each { |cb| cb.call(self) } caught = catch(:halt) do start = Time.now result = _call_filters(_before_filters) @_benchmarks[:before_filters_time] = Time.now - start if _before_filters @body = _call_action(action_name) if result == :filter_chain_completed result end @body = case caught when :filter_chain_completed then @body when String then caught # return *something* if you throw halt with nothing when nil then "<html><body><h1>Filter Chain Halted!</h1></body></html>" when Symbol then __send__(caught) when Proc then self.instance_eval(&caught) else raise ArgumentError, "Threw :halt, #{caught}. Expected String, nil, Symbol, Proc." end start = Time.now _call_filters(_after_filters) @_benchmarks[:after_filters_time] = Time.now - start if _after_filters self._after_dispatch_callbacks.each { |cb| cb.call(self) } @body end
Evaluates a filter condition (:if or :unless)
condition<Symbol, Proc> |
The condition to evaluate. |
ArgumentError |
condition not a Symbol or Proc. |
Boolean |
True if the condition is met. |
If condition is a symbol, it will be send'ed. If it is a Proc it will be called directly with self as an argument.
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 425 def _evaluate_condition(condition) case condition when Symbol then self.send(condition) when Proc then self.instance_eval(&condition) else raise ArgumentError, 'Filter condtions need to be either a Symbol or a Proc' end end
Determines whether the filter should be run based on the conditions passed (:if and :unless)
rule<Hash> |
Rules for the filter (see below). |
:if<Array> |
Optional conditions that must be met for the filter to fire. |
:unless<Array> |
Optional conditions that must not be met for the filter to fire. |
Boolean |
True if the conditions are met. |
:api: private
# File lib/merb-core/controller/abstract_controller.rb, line 401 def _filter_condition_met?(rule) # Both: # * no :if or the if condition evaluates to true # * no :unless or the unless condition evaluates to false (!rule.key?(:if) || _evaluate_condition(rule[:if])) && (!rule.key?(:unless) || ! _evaluate_condition(rule[:unless])) end
This is called after the controller is instantiated to figure out where to look for templates under the _template_root. Override this to define a new structure for your app.
context<~to_s> |
The controller context (the action or template name). |
type<~to_s> |
The content type. Could be nil. |
controller<~to_s> |
The name of the controller. Defaults to being called with the controller_name. Set t |
Indicating where to look for the template for the current controller, context, and content-type. |
The type is irrelevant for controller-types that don't support content-type negotiation, so we default to not include it in the superclass.
def _template_location "#{params[:controller]}.#{params[:action]}.#{content_type}" end
This would look for templates at controller.action.mime.type instead of controller/action.mime.type
:api: public @overridable
# File lib/merb-core/controller/abstract_controller.rb, line 171 def _template_location(context, type, controller) controller ? "#{controller}/#{context}" : context end
Returns the absolute url including the passed protocol and host.
This uses the same arguments as the url method, with added requirements of protocol and host options.
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 557 def absolute_url(*args) # FIXME: arrgh, why request.protocol returns http://? # :// is not part of protocol name options = extract_options_from_args!(args) || {} protocol = options.delete(:protocol) host = options.delete(:host) raise ArgumentError, "The :protocol option must be specified" unless protocol raise ArgumentError, "The :host option must be specified" unless host args << options protocol + "://" + host + url(*args) end
Calls the capture method for the selected template engine.
*args |
Arguments to pass to the block. |
&block |
The block to call. |
The output of a template block or the return value of a non-template block converted to a string. |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 616 def capture(*args, &block) ret = nil captured = send("capture_#{@_engine}", *args) do |*args| ret = yield *args end # return captured value only if it is not empty captured.empty? ? ret.to_s : captured end
Calls the concatenate method for the selected template engine.
str<String> |
The string to concatenate to the buffer. |
binding<Binding> |
The binding to use for the buffer. |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 634 def concat(str, binding) send("concat_#{@_engine}", str, binding) end
The controller name in path form, e.g. "admin/items". |
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 138 def controller_name() self.class.controller_name end
Generates a URL for a single or nested resource.
resources<Symbol,Object> |
The resources for which the URL |
should be generated. These resources should be specified in the router.rb file using #resources and #resource.
options<Hash> |
Any extra parameters that are needed to |
generate the URL.
The generated URL. |
resources :users do resources :comments end
end
resource(:users) # => /users resource(@user) # => /users/10 resource(@user, :comments) # => /users/10/comments resource(@user, @comment) # => /users/10/comments/15 resource(:users, :new) # => /users/new resource(:@user, :edit) # => /users/10/edit
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 601 def resource(*args) args << {} Merb::Router.resource(*args) end
There are three possible ways to use this method. First, if you have a named route, you can specify the route as the first parameter as a symbol and any paramters in a hash. Second, you can generate the default route by just passing the params hash, just passing the params hash. Finally, you can use the anonymous parameters. This allows you to specify the parameters to a named route in the order they appear in the router.
name<Symbol> |
The name of the route. |
args<Hash> |
Parameters for the route generation. |
args<Hash> |
Parameters for the route generation. This route will use the default route. |
name<Symbol> |
The name of the route. |
args<Array> |
An array of anonymous parameters to generate the route with. These parameters are assigned to the route parameters in the order that they are passed. |
The generated URL. |
Named Route
match("/articles/:title").to(:controller => :articles, :action => :show).name("articles")
end
url(:articles, :title => "new_article")
Default Route
default_routes
end
url(:controller => "articles", :action => "new")
Anonymous Paramters
match("/articles/:year/:month/:title").to(:controller => :articles, :action => :show).name("articles")
end
url(:articles, 2008, 10, "test_article")
:api: public
# File lib/merb-core/controller/abstract_controller.rb, line 544 def url(name, *args) args << {} Merb::Router.url(name, *args) end
Generated with the Darkfish Rdoc Generator 2.