\FOFDispatcher

FrameworkOnFramework dispatcher class

FrameworkOnFramework is a set of classes whcih 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.

Synopsis

class FOFDispatcher extends JObject {

• // members
• protected  $config;
• protected FOFInput  $input;
• public  $defaultView;
• protected  $fofAuth_timeStep;
• protected  $fofAuth_Key;
• protected  $fofAuth_Formats;
• protected  $fofAuth_LogoutOnReturn;
• protected  $fofAuth_AuthMethods;
• private bool  $_fofAuth_isLoggedIn;
• private  $_fofAuth_CryptoKey;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• public static FOFDispatcher getAnInstance()
• public static FOFDispatcher getTmpInstance()
• public void __construct()
• public null|JError dispatch()
• protected string getTask()
• public boolean onBeforeDispatch()
• public boolean onBeforeDispatchCLI()
• public boolean onAfterDispatch()
• public void transparentAuthentication()
• private array _decryptWithTOTP()
• private string _createDecryptionKey()
• public static array isCliAdmin()
• // Inherited methods from JObject
• public void __construct()
• public string __toString()
• public mixed def()
• public mixed get()
• public array getProperties()
• public string getError()
• public array getErrors()
• public mixed set()
• public boolean setProperties()
• public void setError()
}


Hierarchy

Extends

• JObject

Tasks

Tasks

Line	Task
519	Check the format

Members

private

• $_fofAuth_CryptoKey — string
• $_fofAuth_isLoggedIn — bool

protected

• $_errors — array
  An array of error messages or Exception objects.
• $config — array
• $fofAuth_AuthMethods — array
• $fofAuth_Formats — array
• $fofAuth_Key — string
• $fofAuth_LogoutOnReturn — boolean
  Should I logout the transparently authenticated user on logout? Recommended to leave it on in order to avoid crashing the sessions table.
• $fofAuth_timeStep — int
• $input — FOFInput

public

• $defaultView — string

Methods

private

• _createDecryptionKey() — Creates a decryption key for use with the TOTP decryption method
• _decryptWithTOTP() — Decrypts a transparent authentication message using a TOTP

protected

• getTask() — Tries to guess the controller task to execute based on the view name and the HTTP request method.

public

• __construct() — Public constructor
• dispatch() — The main code of the Dispatcher. It spawns the necessary controller and runs it.
• getAnInstance() — Get a static (Singleton) instance of a particular Dispatcher
• getTmpInstance() — Gets a temporary instance of a Dispatcher
• isCliAdmin() — Main function to detect if we're running in a CLI environment and we're admin
• onAfterDispatch() — Executes right after the dispatcher runs the controller.
• onBeforeDispatch() — Executes right before the dispatcher tries to instantiate and run the controller.
• onBeforeDispatchCLI() — Sets up some environment variables, so we can work as usually on CLI, too.
• transparentAuthentication() — Transparently authenticates a user

Inherited from JObject

public

• __toString() — Magic method to convert the object to a string gracefully.
• def() — Sets a default value if not alreay assigned
• get() — Returns a property of the object or the default value if the property is not set.
• getError() — Get the most recent error message.
• getErrors() — Return all errors, if any.
• getProperties() — Returns an associative array of object properties.
• set() — Modifies a property of the object, creating it if it does not already exist.
• setError() — Add an error message.
• setProperties() — Set the object properties based on a named array/hash.