Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
authorise | ( | $action, | |
$assetname | |||
) |
Perform an ACL check. Please note that FOF uses by default the Joomla! CMS convention for ACL privileges, e.g core.edit for the edit privilege. If your platform uses different conventions you'll have to override the FOF defaults using fof.xml or by specialising the controller.
string | $action | The ACL privilege to check, e.g. core.edit |
string | $assetname | The asset name to check, typically the component's name |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
authorizeAdmin | ( | $component | ) |
By default FOF will only use the Controller's onBefore* methods to perform user authorisation. In some cases, like the Joomla! back-end, you also need to perform component-wide user authorisation in the Dispatcher. This method MUST implement this authorisation check. If you do not need this in your platform, please always return true.
string | $component | The name of the component. |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
checkExecution | ( | ) |
Checks if the current script is run inside a valid CMS execution
Implémenté dans FOFIntegrationJoomlaPlatform.
checkVersion | ( | $version1, | |
$version2, | |||
$operator | |||
) |
Performs a check between two versions. Use this function instead of PHP version_compare so we can mock it while testing
string | $version1 | First version number |
string | $version2 | Second version number |
string | $operator | Operator (see version_compare for valid operators) |
@return boolean
Implémenté dans FOFPlatform.
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.
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
getCache | ( | $key, | |
$default = null |
|||
) |
Retrieves data from the cache. This is supposed to be used for system-side FOF data, not application data.
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 |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
getComponentBaseDirs | ( | $component | ) |
Returns the base (root) directories for a given component. The "component" is used in the sense of what we call "component" in Joomla!, "plugin" in WordPress and "module" in Drupal, i.e. an application which is running inside our main application (CMS).
The return is a table with the following keys:
All paths MUST be absolute. All four paths MAY be the same if the platform doesn't make a distinction between public and private parts, or when the component does not provide both a public and private part. All of the directories MUST be defined and non-empty.
string | $component | The name of the component. For Joomla! this is something like "com_example" |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
getConfig | ( | ) |
Returns an object that holds the configuration of the current site.
Implémenté dans FOFIntegrationJoomlaPlatform.
Returns an object to handle dates
mixed | $time | The initial time |
null | $tzOffest | The timezone offset |
bool | $locale | Should I try to load a specific class for current language? |
Implémenté dans FOFIntegrationJoomlaPlatform.
getDbo | ( | ) |
Implémenté dans FOFIntegrationJoomlaPlatform.
getDocument | ( | ) |
Returns the JDocument object which handles this component's response. You may also return null and FOF will a. try to figure out the output type by examining the "format" input parameter (or fall back to "html") and b. FOF will not attempt to load CSS and Javascript files (as it doesn't make sense if there's no JDocument to handle them).
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
getIntegrationObject | ( | $key | ) |
Returns a platform integration object
string | $key | The key name of the platform integration object, e.g. 'filesystem' |
Implémenté dans FOFPlatform.
getLanguage | ( | ) |
Implémenté dans FOFIntegrationJoomlaPlatform.
getOrdering | ( | ) |
Returns the ordering of the platform class. Files with a lower ordering number will be loaded first.
Implémenté dans FOFPlatform.
getPlatformBaseDirs | ( | ) |
Returns absolute path to directories used by the CMS.
The return is a table with the following key:
Implémenté dans FOFIntegrationJoomlaPlatform.
getPlatformHumanName | ( | ) |
Returns the human readable platform name, e.g. "Joomla!", "Joomla! Framework", "Something Something Something Framework" etc.
Implémenté dans FOFPlatform.
getPlatformName | ( | ) |
Returns the (internal) name of the platform implementation, e.g. "joomla", "foobar123" etc. This MUST be the last part of the platform class name. For example, if you have a plaform implementation class FOFPlatformFoobar you MUST return "foobar" (all lowercase).
Implémenté dans FOFPlatform.
getPlatformVersion | ( | ) |
Returns the version number string of the platform, e.g. "4.5.6". If implementation integrates with a CMS or a versioned foundation (e.g. a framework) it is advisable to return that version.
Implémenté dans FOFPlatform.
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 directorues. If the application does not have such a thing as template overrides return an empty string.
string | $component | The name of the component for which to fetch the overrides |
boolean | $absolute | Should I return an absolute or relative path? |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
getTemplateSuffixes | ( | ) |
Get application-specific suffixes to use with template paths. This allows you to look for view template overrides based on the application version.
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
getUser | ( | $id = null | ) |
Returns a user object.
integer | $id | The user ID to load. Skip or use null to retrieve the object for the currently logged in user. |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
getUserStateFromRequest | ( | $key, | |
$request, | |||
$input, | |||
$default = null , |
|||
$type = 'none' , |
|||
$setUserState = true |
|||
) |
This method will try retrieving a variable from the request (input) data. If it doesn't exist it will be loaded from the user state, typically stored in the session. If it doesn't exist there either, the $default value will be used. If $setUserState is set to true, the retrieved variable will be stored in the user session.
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? |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
Return a list of the view template paths for this component. The paths are in the format site:/component_name/view_name/layout_name or admin:/component_name/view_name/layout_name
The list of paths returned is a prioritised list. If a file is found in the first path the other paths will not be scanned.
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. |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
importPlugin | ( | $type | ) |
Load plugins of a specific type. Obviously this seems to only be required in the Joomla! CMS.
string | $type | The type of the plugins to be loaded |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
isBackend | ( | ) |
Is this the administrative section of the component?
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
isCli | ( | ) |
Is this a component running in a CLI application?
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
isEnabled | ( | ) |
Is this platform enabled? This is used for automatic platform detection. If the environment we're currently running in doesn't seem to be your platform return false. If many classes return true, the one with the lowest order will be picked by FOFPlatform.
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
isFrontend | ( | ) |
Is this the public section of the component?
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
isGlobalFOFCacheEnabled | ( | ) |
Is the global FOF cache enabled?
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
loadTranslations | ( | $component | ) |
Load the translation files for a given component. The "component" is used in the sense of what we call "component" in Joomla!, "plugin" in WordPress and "module" in Drupal, i.e. an application which is running inside our main application (CMS).
string | $component | The name of the component. For Joomla! this is something like "com_example" |
Implémenté dans FOFPlatform, et FOFIntegrationJoomlaPlatform.
logAddLogger | ( | $file | ) |
Implémenté dans FOFIntegrationJoomlaPlatform.
logDebug | ( | $message | ) |
Implémenté dans FOFIntegrationJoomlaPlatform.
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.
string | $message | The deprecated practice log message |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
loginUser | ( | $authInfo | ) |
logs in a user
array | $authInfo | authentication information |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
logoutUser | ( | ) |
logs out a user
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
raiseError | ( | $code, | |
$message | |||
) |
Raises an error, using the logic requested by the CMS (PHP Exception or dedicated class)
integer | $code | |
string | $message |
Implémenté dans FOFIntegrationJoomlaPlatform.
runPlugins | ( | $event, | |
$data | |||
) |
Execute plugins (system-level triggers) and fetch back an array with their return values.
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 |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
sendHeaders | ( | ) |
In platforms that perform header caching, send all headers.
Implémenté dans FOFIntegrationJoomlaPlatform.
setCache | ( | $key, | |
$content | |||
) |
Saves something to the cache. This is supposed to be used for system-wide FOF data, not application data.
string | $key | The key of the data to save |
string | $content | The actual data to save |
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
setErrorHandling | ( | $level, | |
$log_level, | |||
$options = array() |
|||
) |
Set the error Handling, if possible
integer | $level | PHP error level (E_ALL) |
string | $log_level | What to do with the error (ignore, callback) |
array | $options | Options for the error handler |
Implémenté dans FOFPlatform.
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)
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. |
Implémenté dans FOFIntegrationJoomlaPlatform.
setIntegrationObject | ( | $key, | |
$object | |||
) |
Forces a platform integration object instance
string | $key | The key name of the platform integration object, e.g. 'filesystem' |
object | $object | The object to force for this key |
Implémenté dans FOFPlatform.
supportsAjaxOrdering | ( | ) |
Is AJAX re-ordering supported? This is 100% Joomla!-CMS specific. All other platforms should return false and never ask why.
Implémenté dans FOFIntegrationJoomlaPlatform, et FOFPlatform.
URIbase | ( | $pathonly = false | ) |
Returns the base URI for the request.
boolean | $pathonly | If false, prepend the scheme, host and port information. Default is false. | |
Implémenté dans FOFIntegrationJoomlaPlatform.
Returns the root URI for the request.
boolean | $pathonly | If false, prepend the scheme, host and port information. Default is false. |
string | $path | The path |
Implémenté dans FOFIntegrationJoomlaPlatform.