Graphe d'héritage de FOFIntegrationJoomlaPlatform:

Fonctions membres publiques
	__construct ()

	checkExecution ()

	raiseError ($code, $message)

	isEnabled ()

	getPlatformBaseDirs ()

	getComponentBaseDirs ($component)

	getViewTemplatePaths ($component, $view, $layout='default', $tpl=null, $strict=false)

	getTemplateSuffixes ()

	getTemplateOverridePath ($component, $absolute=true)

	loadTranslations ($component)

	authorizeAdmin ($component)

	getUser ($id=null)

	getDocument ()

	getDate ($time='now', $tzOffest=null, $locale=true)

	getLanguage ()

	getDbo ()

	getUserStateFromRequest ($key, $request, $input, $default=null, $type='none', $setUserState=true)

	importPlugin ($type)

	runPlugins ($event, $data)

	authorise ($action, $assetname)

	isBackend ()

	isFrontend ()

	isCli ()

	supportsAjaxOrdering ()

	isGlobalFOFCacheEnabled ()

	setCache ($key, $content)

	getCache ($key, $default=null)

	clearCache ()

	getConfig ()

	loginUser ($authInfo)

	logoutUser ()

	logAddLogger ($file)

	logDeprecated ($message)

	logDebug ($message)

	URIroot ($pathonly=false, $path=null)

	URIbase ($pathonly=false)

	setHeader ($name, $value, $replace=false)

	sendHeaders ()

Fonctions membres publiques hérités de FOFPlatform
	getOrdering ()

	isEnabled ()

	getIntegrationObject ($key)

	setIntegrationObject ($key, $object)

	setErrorHandling ($level, $log_level, $options=array())

	getComponentBaseDirs ($component)

	getViewTemplatePaths ($component, $view, $layout='default', $tpl=null, $strict=false)

	getTemplateSuffixes ()

	getTemplateOverridePath ($component, $absolute=true)

	loadTranslations ($component)

	authorizeAdmin ($component)

	getUser ($id=null)

	getDocument ()

	getUserStateFromRequest ($key, $request, $input, $default=null, $type='none', $setUserState=true)

	importPlugin ($type)

	runPlugins ($event, $data)

	authorise ($action, $assetname)

	isBackend ()

	isFrontend ()

	isCli ()

	supportsAjaxOrdering ()

	checkVersion ($version1, $version2, $operator)

	setCache ($key, $content)

	getCache ($key, $default=null)

	isGlobalFOFCacheEnabled ()

	clearCache ()

	loginUser ($authInfo)

	logoutUser ()

	logDeprecated ($message)

	getPlatformName ()

	getPlatformVersion ()

	getPlatformHumanName ()

Fonctions membres protégées
	isCliAdmin ()

Fonctions membres privées
&	getCacheObject ($force=false)

	saveCache ()

Attributs privés
	$_cache = null

Membres hérités additionnels
Fonctions membres publiques statiques hérités de FOFPlatform
static	registerPlatformPath ($path)

static	unregisterPlatformPath ($path)

static	forceInstance ($instance)

static	getInstance ()

Champs de données hérités de FOFPlatform
	$ordering = 100

	$name = ''

	$humanReadableName = 'Unknown Platform'

	$version = ''

Attributs protégés hérités de FOFPlatform
	$isEnabled = null

	$objectCache = array()

Attributs protégés statiques hérités de FOFPlatform
static	$paths = array()

static	$instance = null

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Public constructor

Références name.

Documentation des fonctions membres

◆ authorise()

authorise	(	$action,
		$assetname
	)

Perform an ACL check.

Paramètres

string	$action	The ACL privilege to check, e.g. core.edit
string	$assetname	The asset name to check, typically the component's name

Voir également: FOFPlatformInterface::authorise()

Renvoie: boolean True if the user is allowed this action

Implémente FOFPlatformInterface.

Références $action.

◆ authorizeAdmin()

authorizeAdmin ( $component )

Authorise access to the component in the back-end.

Paramètres

string $component The name of the component.

Voir également: FOFPlatformInterface::authorizeAdmin()

Renvoie: boolean True to allow loading the component, false to halt loading

Implémente FOFPlatformInterface.

Références $component, et $user.

◆ checkExecution()

checkExecution ( )

Checks if the current script is run inside a valid CMS execution

Voir également: FOFPlatformInterface::checkExecution()

Renvoie: bool

Implémente FOFPlatformInterface.

◆ clearCache()

clearCache ( )

Clears the cache of system-wide FOF data. You are supposed to call this in your components' installation script post-installation and post-upgrade methods or whenever you are modifying the structure of database tables accessed by FOF. Please note that FOF's cache never expires and is not purged by Joomla!. You MUST use this method to manually purge the cache.

Renvoie: boolean True on success

Implémente FOFPlatformInterface.

◆ getCache()

getCache	(	$key,
		$default = `null`
	)

Retrieves data from the cache. This is supposed to be used for system-side FOF data, not application data.

Paramètres

string	$key	The key of the data to retrieve
string	$default	The default value to return if the key is not found or the cache is not populated

Renvoie: string The cached value

Implémente FOFPlatformInterface.

Références $default, et $key.

◆ getCacheObject()

& getCacheObject ( $force = false )

private

Gets a reference to the cache object, loading it from the disk if needed.

Paramètres

boolean $force Should I forcibly reload the registry?

Renvoie: JRegistry

Références $className, $data, $options, JLoader\import(), et JPATH_CACHE.

◆ getComponentBaseDirs()

getComponentBaseDirs ( $component )

Returns the base (root) directories for a given component.

Paramètres

string $component The name of the component. For Joomla! this is something like "com_example"

Voir également: FOFPlatformInterface::getComponentBaseDirs()

Renvoie: array A hash array with keys main, alt, site and admin.

Implémente FOFPlatformInterface.

Références $component, JPATH_ADMINISTRATOR, et JPATH_SITE.

◆ getConfig()

getConfig ( )

Returns an object that holds the configuration of the current site.

Renvoie: mixed

Implémente FOFPlatformInterface.

◆ getDate()

getDate	(	$time = `'now'`,
		$tzOffest = `null`,
		$locale = `true`
	)

Returns an object to handle dates

Paramètres

mixed	$time	The initial time
null	$tzOffest	The timezone offset
bool	$locale	Should I try to load a specific class for current language?

Renvoie: JDate object

Implémente FOFPlatformInterface.

◆ getDbo()

getDbo ( )

Renvoie: FOFDatabaseDriver

Implémente FOFPlatformInterface.

Références FOFDatabaseFactory\getInstance().

◆ getDocument()

getDocument ( )

Returns the JDocument object which handles this component's response.

Voir également: FOFPlatformInterface::getDocument()

Renvoie: JDocument

Implémente FOFPlatformInterface.

Références $document, getDocument, et null.

◆ getLanguage()

getLanguage ( )

Implémente FOFPlatformInterface.

◆ getPlatformBaseDirs()

getPlatformBaseDirs ( )

Returns absolute path to directories used by the CMS.

Voir également: FOFPlatformInterface::getPlatformBaseDirs()

Renvoie: array A hash array with keys root, public, admin, tmp and log.

Implémente FOFPlatformInterface.

Références JPATH_ADMINISTRATOR, JPATH_ROOT, et JPATH_SITE.

◆ getTemplateOverridePath()

getTemplateOverridePath	(	$component,
		$absolute = `true`
	)

Return the absolute path to the application's template overrides directory for a specific component. We will use it to look for template files instead of the regular component directories. If the application does not have such a thing as template overrides return an empty string.

Paramètres

string	$component	The name of the component for which to fetch the overrides
boolean	$absolute	Should I return an absolute or relative path?

Renvoie: string The path to the template overrides directory

Implémente FOFPlatformInterface.

Références $component, $path, et JPATH_THEMES.

◆ getTemplateSuffixes()

getTemplateSuffixes ( )

Get application-specific suffixes to use with template paths. This allows you to look for view template overrides based on the application version.

Renvoie: array A plain array of suffixes to try in template names

Implémente FOFPlatformInterface.

◆ getUser()

getUser ( $id = null )

Return a user object.

Paramètres

integer $id The user ID to load. Skip or use null to retrieve the object for the currently logged in user.

Voir également: FOFPlatformInterface::getUser()

Renvoie: JUser The JUser object for the specified user

Implémente FOFPlatformInterface.

Références $id.

◆ getUserStateFromRequest()

getUserStateFromRequest	(	$key,
		$request,
		$input,
		$default = `null`,
		$type = `'none'`,
		$setUserState = `true`
	)

This method will try retrieving a variable from the request (input) data.

Paramètres

string	$key	The user state key for the variable
string	$request	The request variable name for the variable
FOFInput	$input	The FOFInput object with the request (input) data
mixed	$default	The default value. Default: null
string	$type	The filter type for the variable data. Default: none (no filtering)
boolean	$setUserState	Should I set the user state with the fetched value?

Voir également: FOFPlatformInterface::getUserStateFromRequest()

Renvoie: mixed The value of the variable

Implémente FOFPlatformInterface.

Références $app, $default, $input, $key, $type, elseif, et null.

◆ getViewTemplatePaths()

getViewTemplatePaths	(	$component,
		$view,
		$layout = `'default'`,
		$tpl = `null`,
		$strict = `false`
	)

Return a list of the view template paths for this component.

Paramètres

string	$component	The name of the component. For Joomla! this is something like "com_example"
string	$view	The name of the view you're looking a template for
string	$layout	The layout name to load, e.g. 'default'
string	$tpl	The sub-template name to load (null by default)
boolean	$strict	If true, only the specified layout will be searched for. Otherwise we'll fall back to the 'default' layout if the specified layout is not found.

Voir également: FOFPlatformInterface::getViewTemplateDirs()

Renvoie: array

Implémente FOFPlatformInterface.

Références $basePath, $component, $layout, $view, FOFInflector\isSingular(), FOFInflector\pluralize(), et FOFInflector\singularize().

◆ importPlugin()

importPlugin ( $type )

Load plugins of a specific type. Obviously this seems to only be required in the Joomla! CMS.

Paramètres

string $type The type of the plugins to be loaded

Voir également: FOFPlatformInterface::importPlugin()

Renvoie: void

Implémente FOFPlatformInterface.

Références $type, et JLoader\import().

◆ isBackend()

isBackend ( )

Is this the administrative section of the component?

Voir également: FOFPlatformInterface::isBackend()

Renvoie: boolean

Implémente FOFPlatformInterface.

◆ isCli()

isCli ( )

Is this a component running in a CLI application?

Voir également: FOFPlatformInterface::isCli()

Renvoie: boolean

Implémente FOFPlatformInterface.

◆ isCliAdmin()

isCliAdmin ( )

protected

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 associative array, so we can use list.

Références $app, false, et null.

◆ isEnabled()

isEnabled ( )

Is this platform enabled?

Voir également: FOFPlatformInterface::isEnabled()

Renvoie: boolean

Implémente FOFPlatformInterface.

◆ isFrontend()

isFrontend ( )

Is this the public section of the component?

Voir également: FOFPlatformInterface::isFrontend()

Renvoie: boolean

Implémente FOFPlatformInterface.

◆ isGlobalFOFCacheEnabled()

isGlobalFOFCacheEnabled ( )

Is the global FOF cache enabled?

Renvoie: boolean

Implémente FOFPlatformInterface.

Références JDEBUG.

◆ loadTranslations()

loadTranslations ( $component )

Load the translation files for a given component.

Paramètres

string $component The name of the component. For Joomla! this is something like "com_example"

Voir également: FOFPlatformInterface::loadTranslations()

Renvoie: void

Implémente FOFPlatformInterface.

Références $component, JPATH_ADMINISTRATOR, JPATH_ROOT, et null.

◆ logAddLogger()

logAddLogger ( $file )

Implémente FOFPlatformInterface.

Références $file.

◆ logDebug()

logDebug ( $message )

Implémente FOFPlatformInterface.

Références $message.

◆ logDeprecated()

logDeprecated ( $message )

Logs a deprecated practice. In Joomla! this results in the $message being output in the deprecated log file, found in your site's log directory.

Paramètres

string $message The deprecated practice log message

Renvoie: void

Implémente FOFPlatformInterface.

Références $message.

◆ loginUser()

loginUser ( $authInfo )

logs in a user

Paramètres

array $authInfo authentication information

Renvoie: boolean True on success

Implémente FOFPlatformInterface.

Références $db, $options, $query, $results, $user, et JLoader\import().

◆ logoutUser()

logoutUser ( )

logs out a user

Renvoie: boolean True on success

Implémente FOFPlatformInterface.

Références $app, $options, $parameters, et JLoader\import().

◆ raiseError()

raiseError	(	$code,
		$message
	)

Raises an error, using the logic requested by the CMS (PHP Exception or dedicated class)

Paramètres

integer	$code
string	$message

Renvoie: mixed

Implémente FOFPlatformInterface.

Références $message, et JError\raiseError().

◆ runPlugins()

runPlugins	(	$event,
		$data
	)

Execute plugins (system-level triggers) and fetch back an array with their return values.

Paramètres

string	$event	The event (trigger) name, e.g. onBeforeScratchMyEar
array	$data	A hash array of data sent to the plugins as part of the trigger

Voir également: FOFPlatformInterface::runPlugins()

Renvoie: array A simple array containing the results of the plugins triggered

Implémente FOFPlatformInterface.

Références $app, $data, $dispatcher, et JEventDispatcher\getInstance().

◆ saveCache()

saveCache ( )

private

Save the cache object back to disk

Renvoie: boolean True on success

◆ sendHeaders()

sendHeaders ( )

In platforms that perform header caching, send all headers.

Renvoie: void

Implémente FOFPlatformInterface.

Références JResponse\sendHeaders().

◆ setCache()

setCache	(	$key,
		$content
	)

Saves something to the cache. This is supposed to be used for system-wide FOF data, not application data.

Paramètres

string	$key	The key of the data to save
string	$content	The actual data to save

Renvoie: boolean True on success

Implémente FOFPlatformInterface.

Références $content, et $key.

◆ setHeader()

setHeader	(	$name,
		$value,
		$replace = `false`
	)

Method to set a response header. If the replace flag is set then all headers with the given name will be replaced by the new one (only if the current platform supports header caching)

Paramètres

string	$name	The name of the header to set.
string	$value	The value of the header to set.
boolean	$replace	True to replace any headers with the same name.

Renvoie: void

Implémente FOFPlatformInterface.

Références $name, $value, et JResponse\setHeader().

◆ supportsAjaxOrdering()

supportsAjaxOrdering ( )

Is AJAX re-ordering supported? This is 100% Joomla!-CMS specific. All other platforms should return false and never ask why.

Voir également: FOFPlatformInterface::supportsAjaxOrdering()

Renvoie: boolean

Implémente FOFPlatformInterface.

◆ URIbase()

URIbase ( $pathonly = false )

Returns the base URI for the request.

Paramètres

boolean $pathonly If false, prepend the scheme, host and port information. Default is false. |

Renvoie: string The base URI string

Implémente FOFPlatformInterface.

Références JLoader\import().

◆ URIroot()

URIroot	(	$pathonly = `false`,
		$path = `null`
	)

Returns the root URI for the request.

Paramètres

boolean	$pathonly	If false, prepend the scheme, host and port information. Default is false.
string	$path	The path

Renvoie: string The root URI string.

Implémente FOFPlatformInterface.

Références $path, et JLoader\import().

Documentation des champs

◆ $_cache

$_cache = null

private

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

fof/integration/joomla/platform.php

Fonctions membres publiques

Fonctions membres protégées

Fonctions membres privées

Attributs privés

Membres hérités additionnels

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ authorise()

◆ authorizeAdmin()

◆ checkExecution()

◆ clearCache()

◆ getCache()

◆ getCacheObject()

◆ getComponentBaseDirs()

◆ getConfig()

◆ getDate()

◆ getDbo()

◆ getDocument()

◆ getLanguage()

◆ getPlatformBaseDirs()

◆ getTemplateOverridePath()

◆ getTemplateSuffixes()

◆ getUser()

◆ getUserStateFromRequest()

◆ getViewTemplatePaths()

◆ importPlugin()

◆ isBackend()

◆ isCli()

◆ isCliAdmin()

◆ isEnabled()

◆ isFrontend()

◆ isGlobalFOFCacheEnabled()

◆ loadTranslations()

◆ logAddLogger()

◆ logDebug()

◆ logDeprecated()

◆ loginUser()

◆ logoutUser()

◆ raiseError()

◆ runPlugins()

◆ saveCache()

◆ sendHeaders()

◆ setCache()

◆ setHeader()

◆ supportsAjaxOrdering()

◆ URIbase()

◆ URIroot()

Documentation des champs

◆ $_cache