API Documentation
\

\Horde_Controller_Base

Base class for controllers that implements the Logged, Injected, and Viewed interfaces.

This class is for convenience, if you decide you wish to use only logging or the injector or views, or neither, you do not have to use it. As long as your controllers implement Horde_Controller, they are runnable.

Summary

Methods
Properties
Constants
setInjector()
getInjector()
setLogger()
getLogger()
setView()
getView()
getRequest()
getResponse()
getUrlWriter()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_injector
$_logger
$_view
$_urlWriter
N/A

Properties

$_injector

$_injector : \Horde_Injector

This is marked private on purpose, so that you have to use the getInjector() method to access it in derived classes. This is done so that you don't assume its always set, since its set via setter-injection to save on having to define a constructor param for it

Type

\Horde_Injector

$_logger

$_logger : \Horde_Log_Logger

Private on purpose so you have to use getLogger().

Type

\Horde_Log_Logger

$_view

$_view : \Horde_View

Private on purpose so you have to use getView().

Type

\Horde_View

$_urlWriter

$_urlWriter : \Horde_Controller_UrlWriter

Private on purpose so you have to use getUrlWriter().

Type

\Horde_Controller_UrlWriter

Methods

setInjector()

setInjector(\Horde_Injector  $injector)

Set the injector for this controller

Parameters

\Horde_Injector $injector

getInjector()

getInjector() : \Horde_Injector

Get the injector for this controller

Returns

\Horde_Injector —

The injector previously set for this controller, or a new Horde_Injector_TopLevel

setLogger()

setLogger(\Horde_Log_Logger  $logger)

Set the Logger for this controller

Parameters

\Horde_Log_Logger $logger

getLogger()

getLogger() : \Horde_Log_Logger

Get the logger assigned to this controller

Returns

\Horde_Log_Logger —

The logger for this controller

setView()

setView(\Horde_View_Base  $view)

Set the Horde_View object to be used for this controller

Parameters

\Horde_View_Base $view

getView()

getView() : \Horde_View_Base

Gets the current view for this controller

Returns

\Horde_View_Base —

The view for this controller, or a new empty Horde_View if none is set

getRequest()

getRequest()

Get the current request

getResponse()

getResponse()

Get the current response

getUrlWriter()

getUrlWriter() : \Horde_Controller_UrlWriter

Get an instance of UrlWriter for this controller.

Returns

\Horde_Controller_UrlWriter