Class Index [+]

Quicksearch

Merb::Controller

Attributes

request[R]

:api: public

headers[R]

:api: public

Public Class Methods

_callable_methods() click to toggle source

All methods that are callable as actions.

Returns

Array

A list of method names that are also actions

:api: private

     # File lib/merb-core/controller/merb_controller.rb, line 166
166:   def self._callable_methods
167:     callables = []
168:     klass = self
169:     begin
170:       callables << (klass.public_instance_methods(false) + klass._shown_actions).map{|m| m.to_s} - klass._hidden_actions
171:       klass = klass.superclass
172:     end until klass == Merb::AbstractController || klass == Object
173:     callables.flatten.reject{|action| action =~ /^_.*/}.map {|x| x.to_s}
174:   end
_filter_params(params) click to toggle source

This is a stub method so plugins can implement param filtering if they want.

Parameters

params String}>

A list of params

Returns

Hash{Symbol => String}

A new list of params, filtered as desired

:api: plugin @overridable

     # File lib/merb-core/controller/merb_controller.rb, line 155
155:   def self._filter_params(params)
156:     params
157:   end
abstract!() click to toggle source

Sets a controller to be “abstract” This controller will not be able to be routed to and is used for super classing only

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 453
453:   def self.abstract!
454:     @_abstract = true
455:   end
abstract?() click to toggle source

Asks a controller if it is abstract

Returns

Boolean

 true if the controller has been set as abstract

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 464
464:   def self.abstract?
465:     !!@_abstract 
466:   end
call(env) click to toggle source

Call the controller as a Rack endpoint.

Expects:

  env["merb.status"]:: the default status code to be returned
  env["merb.action_name"]:: the action name to dispatch
  env["merb.request_start"]:: a Time object representing the
    start of the request.

Parameters

env

A rack environment

Returns

Array[Integer, Hash, #]

A standard Rack response

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 251
251:   def self.call(env)
252:     new(Merb::Request.new(env), env["merb.status"])._call
253:   end
callable_actions() click to toggle source

The list of actions that are callable, after taking defaults, _hidden_actions and _shown_actions into consideration. It is calculated once, the first time an action is dispatched for this controller.

Returns

SimpleSet[String]

A set of actions that should be callable.

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 141
141:   def self.callable_actions
142:     @callable_actions ||= Extlib::SimpleSet.new(_callable_methods)
143:   end
hide_action(*names) click to toggle source

Hide each of the given methods from being callable as actions.

Parameters

*names<~to-s>

Actions that should be added to the list.

Returns

Array[String]

An array of actions that should not be possible to dispatch to.

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 98
 98:   def self.hide_action(*names)
 99:     self._hidden_actions = self._hidden_actions | names.map { |n| n.to_s }
100:   end
inherited(klass) click to toggle source

Parameters

klass

The Merb::Controller inheriting from the base class.

:api: private

    # File lib/merb-core/controller/merb_controller.rb, line 27
27:   def self.inherited(klass)
28:     _subclasses << klass.to_s
29:     super
30:     klass._template_root = Merb.dir_for(:view) unless self._template_root
31:   end
new(request, status=200, headers={'Content-Type' => 'text/html; charset=utf-8'}) click to toggle source

Build a new controller.

Sets the variables that came in through the dispatch as available to the controller.

Parameters

request

The Merb::Request that came in from Rack.

status

An integer code for the status. Defaults to 200.

headers value}>

A hash of headers to start the controller with. These headers can be overridden later by the # method.

:api: plugin @overridable

     # File lib/merb-core/controller/merb_controller.rb, line 230
230:   def initialize(request, status=200, headers={'Content-Type' => 'text/html; charset=utf-8'})
231:     super()
232:     @request, @_status, @headers = request, status, headers
233:   end
overridable(*names) click to toggle source

Parameters

*names

an Array of method names that should be overridable in application controllers.

Returns

Array

The list of methods that are overridable

:api: plugin

    # File lib/merb-core/controller/merb_controller.rb, line 42
42:   def self.overridable(*names)
43:     self._overridable.push(*names)
44:   end
override!(*names) click to toggle source

In an application controller, call override! before a method to indicate that you want to override a method in Merb::Controller that is not normally overridable.

Doing this may potentially break your app in a future release of Merb, and this is provided for users who are willing to take that risk. Without using override!, Merb will raise an error if you attempt to override a method defined on Merb::Controller.

This is to help users avoid a common mistake of defining an action that overrides a core method on Merb::Controller.

Parameters

*names

An Array of methods that will override Merb core classes on purpose

Example

    
    class Kontroller < Application
      def status
        render
      end
    end

will raise a Merb::ReservedError, because # is a method on Merb::Controller.

    class Kontroller < Application
      override! :status
      def status
        some_code || super
      end
    end

will not raise a Merb::ReservedError, because the user specifically decided to override the status method.

:api: public

    # File lib/merb-core/controller/merb_controller.rb, line 84
84:   def self.override!(*names)
85:     self._override_bang.push(*names)
86:   end
show_action(*names) click to toggle source

Makes each of the given methods being callable as actions. You can use this to make methods included from modules callable as actions.

Parameters

*names<~to-s>

Actions that should be added to the list.

Returns

Array[String]

An array of actions that should be dispatched to even if they would not otherwise be.

Example

  module Foo
    def self.included(base)
      base.show_action(:foo)
    end

    def foo
      # some actiony stuff
    end

    def foo_helper
      # this should not be an action
    end
  end

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 129
129:   def self.show_action(*names)
130:     self._shown_actions = self._shown_actions | names.map {|n| n.to_s}
131:   end
subclasses_list() click to toggle source

:api: private

    # File lib/merb-core/controller/merb_controller.rb, line 15
15:   def self.subclasses_list() _subclasses end

Private Class Methods

method_added(meth) click to toggle source

When a method is added to a subclass of Merb::Controller (i.e. an app controller) that is defined on Merb::Controller, raise a Merb::ReservedError. An error will not be raised if the method is defined as overridable in the Merb API.

This behavior can be overridden by using override! method_name before attempting to override the method.

Parameters

meth<~to_sym> The method that is being added

Raises

Merb::ReservedError

If the method being added is in a subclass of Merb::Controller, the method is defined on Merb::Controller, it is not defined as overridable in the Merb API, and the user has not specified that it can be overridden.

Returns

nil

:api: private

     # File lib/merb-core/controller/merb_controller.rb, line 508
508:   def self.method_added(meth)
509:     if self < Merb::Controller && Merb::Controller.method_defined?(meth) && 
510:       !self._overridable.include?(meth.to_sym) && !self._override_bang.include?(meth.to_sym)
511: 
512:       raise Merb::ReservedError, "You tried to define #{meth} on "          "#{self.name} but it was already defined on Merb::Controller. "          "If you meant to override a core method, use override!"
513:     end
514:   end

Public Instance Methods

_absolute_template_location(template, type) click to toggle source

The location to look for a template and mime-type. This is overridden from AbstractController, which defines a version of this that does not involve mime-types.

Parameters

template

The absolute path to a template - without mime and template extension. The mime-type extension is optional - it will be appended from the current content type if it hasn’t been added already.

type<~to_s>

The mime-type of the template that will be rendered. Defaults to nil.

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 212
212:   def _absolute_template_location(template, type)
213:     _conditionally_append_extension(template, type)
214:   end
_call() click to toggle source

Dispatches the action and records benchmarks

Returns

Array[Integer, Hash, #]

A standard Rack response

:api: private

     # File lib/merb-core/controller/merb_controller.rb, line 261
261:   def _call
262:     _dispatch(request.env["merb.action_name"])
263:     _benchmarks[:dispatch_time] = Time.now - request.env["merb.request_start"]
264:     Merb.logger.info { _benchmarks.inspect }
265:     Merb.logger.flush
266:     rack_response        
267:   end
_dispatch(action=:index) click to toggle source

Dispatch the action.

Parameters

action<~to_s>

An action to dispatch to. Defaults to :index.

Returns

String

The string sent to the logger for time spent.

Raises

ActionNotFound

The requested action was not found in class.

:api: plugin

     # File lib/merb-core/controller/merb_controller.rb, line 281
281:   def _dispatch(action=:index)
282:     Merb.logger.info { "Params: #{self.class._filter_params(request.params).inspect}" }
283:     start = Time.now
284:     if self.class.callable_actions.include?(action.to_s)
285:       super(action)
286:     else
287:       raise ActionNotFound, "Action '#{action}' was not found in #{self.class}"
288:     end
289:     @_benchmarks[:action_time] = Time.now - start
290:     self
291:   end
_template_location(context, type, controller) click to toggle source

The location to look for a template for a particular controller, context, and mime-type. This is overridden from AbstractController, which defines a version of this that does not involve mime-types.

Parameters

context<~to_s>

The name of the action or template basename that will be rendered.

type<~to_s>

The mime-type of the template that will be rendered. Defaults to nil.

controller<~to_s>

The name of the controller that will be rendered. Defaults to controller_name. This will be “layout” for rendering a layout.

Notes

By default, this renders “:controller/:action.:type”. To change this, override it in your application class or in individual controllers.

:api: public @overridable

     # File lib/merb-core/controller/merb_controller.rb, line 194
194:   def _template_location(context, type, controller)
195:     _conditionally_append_extension(controller ? "#{controller}/#{context}" : "#{context}", type)
196:   end
absolute_url(*args) click to toggle source

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/merb_controller.rb, line 429
429:   def absolute_url(*args)
430:     options  = extract_options_from_args!(args) || {}
431:     options[:protocol] ||= request.protocol
432:     options[:host] ||= request.host
433:     args << options
434:     super(*args)
435:   end
params() click to toggle source

Returns

Hash

The parameters from the request object

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 324
324:   def params()  request.params  end
rack_response() click to toggle source

The results of the controller’s render, to be returned to Rack.

Returns

Array[Integer, Hash, String]

The controller’s status code, headers, and body

:api: private

     # File lib/merb-core/controller/merb_controller.rb, line 444
444:   def rack_response
445:     [status, headers, Merb::Rack::StreamWrapper.new(body)]
446:   end
relative_url(name, *args) click to toggle source
Alias for: url
resource(*args) click to toggle source

Generates a URL for a single or nested resource.

Parameters

resources

The resources for which the URL

  should be generated. These resources should be specified
  in the router.rb file using #resources and #resource.
options

Any extra parameters that are needed to

  generate the URL.

Returns

String

The generated URL.

Examples

Merb::Router.prepare do

  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/merb_controller.rb, line 415
415:   def resource(*args)
416:     args << params
417:     Merb::Router.resource(*args)
418:   end
status() click to toggle source

Returns

Fixnum

The response status code

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 300
300:   def status
301:     @_status
302:   end
status=(s) click to toggle source

Set the response status code.

Parameters

s

A status-code or named http-status

:api: public

     # File lib/merb-core/controller/merb_controller.rb, line 310
310:   def status=(s)
311:     if s.is_a?(Symbol) && STATUS_CODES.key?(s)
312:       @_status = STATUS_CODES[s]
313:     elsif s.is_a?(Fixnum)
314:       @_status = s
315:     else
316:       raise ArgumentError, "Status should be of type Fixnum or Symbol, was #{s.class}"
317:     end
318:   end
url(name, *args) click to toggle source

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.

Parameters(Named Route)

name

The name of the route.

args

Parameters for the route generation.

Parameters(Default Route)

args

Parameters for the route generation. This route will use the default route.

Parameters(Anonymous Parameters)

name

The name of the route.

args

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.

Returns

String

The generated URL.

Examples

Named Route

Merb::Router.prepare do

  match("/articles/:title").to(:controller => :articles, :action => :show).name("articles")

end

url(:articles, :title => “new_article“)

Default Route

Merb::Router.prepare do

  default_routes

end

url(:controller => “articles”, :action => “new”)

Anonymous Paramters

Merb::Router.prepare do

  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/merb_controller.rb, line 380
380:   def url(name, *args)
381:     args << params
382:     name = request.route if name == :this
383:     Merb::Router.url(name, *args)
384:   end
Also aliased as: relative_url

Private Instance Methods

_conditionally_append_extension(template, type) click to toggle source

If not already added, add the proper mime extension to the template path.

Parameters

template<~to_s>

The template path to append the mime type to.

type<~to_s>

The extension to append to the template path conditionally

:api: private

     # File lib/merb-core/controller/merb_controller.rb, line 483
483:   def _conditionally_append_extension(template, type)
484:     type && !template.match(/\.#{type.to_s.escape_regexp}$/) ? "#{template}.#{type}" : template
485:   end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.