Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FOFDispatcher
+ Graphe d'héritage de FOFDispatcher:

Fonctions membres publiques

 __construct ($config=array())
 
 dispatch ()
 
 onBeforeDispatch ()
 
 onBeforeDispatchCLI ()
 
 onAfterDispatch ()
 
 transparentAuthentication ()
 
- Fonctions membres publiques hérités de FOFUtilsObject
 __construct ($properties=null)
 
 __toString ()
 
 def ($property, $default=null)
 
 get ($property, $default=null)
 
 getProperties ($public=true)
 
 getError ($i=null, $toString=true)
 
 getErrors ()
 
 set ($property, $value=null)
 
 setProperties ($properties)
 
 setError ($error)
 

Fonctions membres publiques statiques

static & getAnInstance ($option=null, $view=null, $config=array())
 
static & getTmpInstance ($option=null, $view=null, $config=array())
 
static isCliAdmin ()
 

Champs de données

 $defaultView = 'cpanel'
 

Fonctions membres protégées

 getTask ($view)
 

Attributs protégés

 $config = array()
 
 $input = array()
 
 $fofAuth_timeStep = 6
 
 $fofAuth_Key = null
 
 $fofAuth_Formats = array('json', 'csv', 'xml', 'raw')
 
 $fofAuth_LogoutOnReturn = true
 
 $fofAuth_AuthMethods
 
- Attributs protégés hérités de FOFUtilsObject
 $_errors = array()
 

Fonctions membres privées

 _decryptWithTOTP ($encryptedData)
 
 _createDecryptionKey ($time=null)
 

Attributs privés

 $_fofAuth_isLoggedIn = false
 
 $_fofAuth_CryptoKey = ''
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Public constructor

Paramètres
array$configThe configuration variables

Références $config, $task, FOFConfigProvider\get(), null, et view.

Documentation des fonctions membres

◆ _createDecryptionKey()

_createDecryptionKey (   $time = null)
private

Creates a decryption key for use with the TOTP decryption method

Paramètres
integer$timeThe timestamp used for TOTP calculation, leave empty to use current timestamp
Renvoie
string THe encryption key

Références $key.

◆ _decryptWithTOTP()

_decryptWithTOTP (   $encryptedData)
private

Decrypts a transparent authentication message using a TOTP

Paramètres
string$encryptedDataThe encrypted data
Renvoie
array The decrypted data

Références $i, et null.

◆ dispatch()

dispatch ( )

The main code of the Dispatcher. It spawns the necessary controller and runs it.

Exceptions
Exception
Renvoie
void|Exception

Références $config, $controller, $format, $input, $option, $task, $view, elseif, FOFPlatform\getInstance(), FOFController\getTmpInstance(), null, FOFInflector\pluralize(), et FOFInflector\singularize().

◆ getAnInstance()

static& getAnInstance (   $option = null,
  $view = null,
  $config = array() 
)
static

Get a static (Singleton) instance of a particular Dispatcher

Paramètres
string$optionThe component name
string$viewThe View name
array$configConfiguration data

array $instances Holds the array of Dispatchers FOF knows about

Renvoie
FOFDispatcher

Références $config, $hash, $option, et $view.

◆ getTask()

getTask (   $view)
protected

Tries to guess the controller task to execute based on the view name and the HTTP request method.

Paramètres
string$viewThe name of the view
Renvoie
string The best guess of the task to execute

Références $id, $task, $view, elseif, FOFPlatform\getInstance(), FOFInflector\isPlural(), et null.

◆ getTmpInstance()

static& getTmpInstance (   $option = null,
  $view = null,
  $config = array() 
)
static

Gets a temporary instance of a Dispatcher

Paramètres
string$optionThe component name
string$viewThe View name
array$configConfiguration data
Renvoie
FOFDispatcher

Références $className, $config, $input, $option, $path, $view, et FOFPlatform\getInstance().

◆ isCliAdmin()

static isCliAdmin ( )
static

Main function to detect if we're running in a CLI environment and we're admin

Renvoie
array isCLI and isAdmin. It's not an associtive array, so we can use list.

Références FOFPlatform\getInstance(), et null.

Référencé par FOFAutoloaderComponent\autoload_fof_controller(), FOFAutoloaderComponent\autoload_fof_helper(), FOFAutoloaderComponent\autoload_fof_model(), FOFAutoloaderComponent\autoload_fof_table(), FOFAutoloaderComponent\autoload_fof_toolbar(), et FOFAutoloaderComponent\autoload_fof_view().

◆ onAfterDispatch()

onAfterDispatch ( )

Executes right after the dispatcher runs the controller.

Renvoie
boolean Return false to abort

Références FOFPlatform\getInstance().

◆ onBeforeDispatch()

onBeforeDispatch ( )

Executes right before the dispatcher tries to instantiate and run the controller.

Renvoie
boolean Return false to abort

◆ onBeforeDispatchCLI()

onBeforeDispatchCLI ( )

Sets up some environment variables, so we can work as usually on CLI, too.

Renvoie
boolean Return false to abort

Références $option, FOFPlatform\getInstance(), et JLoader\import().

◆ transparentAuthentication()

transparentAuthentication ( )

Transparently authenticates a user

Renvoie
void

Références $format, elseif, FOFPlatform\getInstance(), et null.

Documentation des champs

◆ $_fofAuth_CryptoKey

$_fofAuth_CryptoKey = ''
private

◆ $_fofAuth_isLoggedIn

$_fofAuth_isLoggedIn = false
private

◆ $config

$config = array()
protected

◆ $defaultView

$defaultView = 'cpanel'

◆ $fofAuth_AuthMethods

$fofAuth_AuthMethods
protected
Valeur initiale :
= array(
'HTTPBasicAuth_TOTP',
'QueryString_TOTP',
'HTTPBasicAuth_Plaintext',
'QueryString_Plaintext',
'SplitQueryString_Plaintext',
)

◆ $fofAuth_Formats

$fofAuth_Formats = array('json', 'csv', 'xml', 'raw')
protected

◆ $fofAuth_Key

$fofAuth_Key = null
protected

◆ $fofAuth_LogoutOnReturn

$fofAuth_LogoutOnReturn = true
protected

◆ $fofAuth_timeStep

$fofAuth_timeStep = 6
protected

◆ $input

$input = array()
protected

La documentation de cette classe a été générée à partir du fichier suivant :