Class FOFDispatcher

FrameworkOnFramework dispatcher class

FrameworkOnFramework is a set of classes which extend Joomla! 1.5 and later's MVC framework with features making maintaining complex software much easier, without tedious repetitive copying of the same code over and over again.

FOFUtilsObject

FOFDispatcher

Package: FrameworkOnFramework\dispatcher
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.0
Located at fof/dispatcher/dispatcher.php

Methods summary

`public static FOFDispatcher &`	# `getAnInstance( string $option = null, string $view = null, array $config = array() )` Get a static (Singleton) instance of a particular Dispatcher Get a static (Singleton) instance of a particular Dispatcher Parameters `$option` `string` - $option The component name `$view` `string` - $view The View name `$config` `array` - $config Configuration data Returns `FOFDispatcher`
`public static FOFDispatcher &`	# `getTmpInstance( string $option = null, string $view = null, array $config = array() )` Gets a temporary instance of a Dispatcher Gets a temporary instance of a Dispatcher Parameters `$option` `string` - $option The component name `$view` `string` - $view The View name `$config` `array` - $config Configuration data Returns `FOFDispatcher`
`public`	# `__construct( array $config = array() )` Public constructor Public constructor Parameters `$config` `array` - $config The configuration variables Overrides `FOFUtilsObject::__construct`
`public \|Exception`	# `dispatch( )` The main code of the Dispatcher. It spawns the necessary controller and runs it. The main code of the Dispatcher. It spawns the necessary controller and runs it. Returns `\|Exception` Throws `Exception`
`protected string`	# `getTask( string $view )` Tries to guess the controller task to execute based on the view name and the HTTP request method. Tries to guess the controller task to execute based on the view name and the HTTP request method. Parameters `$view` `string` - $view The name of the view Returns `string` - The best guess of the task to execute
`public boolean`	# `onBeforeDispatch( )` Executes right before the dispatcher tries to instantiate and run the controller. Executes right before the dispatcher tries to instantiate and run the controller. Returns `boolean` - Return false to abort
`public boolean`	# `onBeforeDispatchCLI( )` Sets up some environment variables, so we can work as usually on CLI, too. Sets up some environment variables, so we can work as usually on CLI, too. Returns `boolean` - Return false to abort
`public boolean`	# `onAfterDispatch( )` Executes right after the dispatcher runs the controller. Executes right after the dispatcher runs the controller. Returns `boolean` - Return false to abort
`public`	# `transparentAuthentication( )` Transparently authenticates a user Transparently authenticates a user
`public static array`	# `isCliAdmin( )` Main function to detect if we're running in a CLI environment and we're admin Main function to detect if we're running in a CLI environment and we're admin Returns `array` - isCLI and isAdmin. It's not an associtive array, so we can use list.

Methods inherited from FOFUtilsObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected array`	`$config`	# Configuration variables Configuration variables
`protected FOFInput`	`$input`	# Input variables Input variables
`public string`	`$defaultView`	# The name of the default view, in case none is specified The name of the default view, in case none is specified
`protected integer`	`$fofAuth_timeStep`	# The Time Step for the TOTP used in FOF's transparent user authentication The Time Step for the TOTP used in FOF's transparent user authentication
`protected string`	`$fofAuth_Key`	# The key for the TOTP, Base32 encoded (watch out; Base32, NOT Base64!) The key for the TOTP, Base32 encoded (watch out; Base32, NOT Base64!)
`protected array`	`$fofAuth_Formats`	# Which formats to be handled by transparent authentication Which formats to be handled by transparent authentication
`protected boolean`	`$fofAuth_LogoutOnReturn`	# Should I logout the transparently authenticated user on logout? Recommended to leave it on in order to avoid crashing the sessions table. Should I logout the transparently authenticated user on logout? Recommended to leave it on in order to avoid crashing the sessions table.
`protected array`	`$fofAuth_AuthMethods`	# Which methods to use to fetch authentication credentials and in which order Which methods to use to fetch authentication credentials and in which order

Properties inherited from FOFUtilsObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDispatcher

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Overrides

Returns

Throws

Parameters

Returns

Returns

Returns

Returns

Returns

Methods inherited from FOFUtilsObject

Magic methods summary

Properties summary

Properties inherited from FOFUtilsObject