Class Horde_Kolab_FreeBusy
The Horde_Kolab_FreeBusy class holds the Registry aka ServiceLocator for the
Free/Busy application. It also provides the entry point into the the Horde
MVC system and allows to dispatch a request.
Copyright 2009-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you did not
receive this file, see
http://www.horde.org/licenses/lgpl21.
Methods summary
public
|
#
__construct( string $type, string $backend, array $params = array() )
Constructor.
Parameters
- $type
- The export type.
- $backend
- The chosen backend.
- $params
- <p>The parameters required to initialize the
application.</p>
<pre><span class="php-quote">'script'</span> - (string) Script name in relation to the document root.
[optional]
<span class="php-quote">'config'</span> - (<span class="php-keyword1">array</span>) Indicates where to find configuration options.
[optional]
<span class="php-quote">'dir'</span> - (string) Configuration files can be found in this
directory.
<span class="php-quote">'request'</span> - (<span class="php-keyword1">array</span>) Options <span class="php-keyword1">for</span> the request object. [optional]
<span class="php-quote">'class'</span> - (string) The <span class="php-keyword1">class</span> of request object to <span class="php-keyword1">use</span> (should
obviously match the request type).
<span class="php-quote">'params'</span> - (<span class="php-keyword1">array</span>) Additional parameters to <span class="php-keyword1">use</span> on request
object construction.
<span class="php-quote">'mapper'</span> - (<span class="php-keyword1">array</span>) Options <span class="php-keyword1">for</span> the mapper object. [optional]
<span class="php-quote">'params'</span> - (<span class="php-keyword1">array</span>) Additional parameters to <span class="php-keyword1">use</span> on mapper
object construction.
<span class="php-quote">'request_config'</span>- (<span class="php-keyword1">array</span>) Options <span class="php-keyword1">for</span> the request configuration. [optional]
<span class="php-quote">'prefix'</span> - (string) The <span class="php-keyword1">class</span> prefix to <span class="php-keyword1">use</span> <span class="php-keyword1">for</span> controllers.
<span class="php-quote">'logger'</span> - (<span class="php-keyword1">array</span>) The keys of the <span class="php-keyword1">array</span> are <span class="php-keyword2">log</span> handler <span class="php-keyword1">class</span> names
(e.g. Horde_Log_Handler_Stream) <span class="php-keyword1">while</span> the
corresponding values are arrays. <span class="php-keyword2">Each</span> such <span class="php-keyword1">array</span>
may contain a <span class="php-keyword2">key</span> <span class="php-quote">'params'</span> that holds parameters
passed to the constructor of the <span class="php-keyword2">log</span> handler. It
may also hold a second <span class="php-keyword2">key</span> <span class="php-quote">'options'</span> with options
passed to the instantiated <span class="php-keyword2">log</span> handler. [optional]
<span class="php-quote">'writer'</span> - (<span class="php-keyword1">array</span>) Options <span class="php-keyword1">for</span> the response writer object. [optional]
<span class="php-quote">'class'</span> - (string) The name of the response writer <span class="php-keyword1">class</span>.
<span class="php-quote">'owner'</span> - (<span class="php-keyword1">array</span>) Options <span class="php-keyword1">for</span> the data owner. [optional]
<span class="php-quote">'domain'</span> - (string) The domain that will be assumed <span class="php-keyword1">for</span>
domainless owners.
<span class="php-quote">'provider'</span> - (<span class="php-keyword1">array</span>) Options <span class="php-keyword1">for</span> the data provider. [optional]
<span class="php-quote">'server'</span> - (string) The URL that will be considered to be
provided locally rather than redirecting
to a remote server.
<span class="php-quote">'redirect'</span> - (boolean) Should non-local requests be redirected
to the remote server <span class="php-keyword1">or</span> should the data
be fetched <span class="php-keyword1">and</span> passed through?
<span class="php-quote">'injector'</span> - (Horde_Injector) An outside injector that allows to
inject arbitrary instance replacements.
[optional]</pre>
|
public
null
|
#
bindings( )
Setup the basic injector bindings.
Setup the basic injector bindings.
Returns
null
|
public
string
|
#
getBackend( )
Return the backend the application uses for the export.
Return the backend the application uses for the export.
Returns
string
The backend used for the export.
|
public
string
|
#
getExportType( )
Return the export type.
Returns
string
The export type.
|
public
mixed
|
#
get( string $interface )
Get an element.
Parameters
- $interface
- The element to retrieve.
Returns
mixed
The element.
|
public
null
|
#
set( string $interface, mixed $instance )
Set an element to the given value.
Set an element to the given value.
Parameters
- $interface
- The element to set.
- $instance
- The value to set the element to.
Returns
null
|
public
null
|
#
dispatch( )
Handle the current request.
Handle the current request.
Returns
null
|