Method |
Description |
|
__construct ( Container $c ) |
Public constructor. |
|
authorise ( string $action, string $assetname ) : boolean |
Perform an ACL check. |
|
authorizeAdmin ( string $component ) : boolean |
Authorise access to the component in the back-end. |
|
clearCache ( ) : boolean |
Clears the cache of system-wide F0F 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 F0F. Please note that F0F's cache never expires and is not
purged by Joomla!. You MUST use this method to manually purge the cache. |
|
getCache ( string $key, string $default = null ) : string |
Retrieves data from the cache. This is supposed to be used for system-side
F0F data, not application data. |
|
getComponentBaseDirs ( string $component ) : array |
Returns the base (root) directories for a given component. |
|
getDocument ( ) : JDocument |
Returns the JDocument object which handles this component's response. |
|
getPlatformVersion ( ) : string |
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. |
|
getTemplate ( boolean | array $params = false ) : string |
Returns the application's template name |
|
getTemplateOverridePath ( string $component, boolean $absolute = true ) : string |
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. |
|
getTemplateSuffixes ( ) : array |
Get application-specific suffixes to use with template paths. This allows
you to look for view template overrides based on the application version. |
|
getUser ( integer $id = null ) : JDocument |
Returns the JUser object for the current user |
|
getUserStateFromRequest ( string $key, string $request, Input $input, mixed $default = null, string $type = 'none', boolean $setUserState = true ) : mixed |
This method will try retrieving a variable from the request (input) data. |
|
importPlugin ( string $type ) : void |
Load plugins of a specific type. Obviously this seems to only be required
in the Joomla! CMS. |
|
isBackend ( ) : boolean |
Is this the administrative section of the component? |
|
isCli ( ) : boolean |
Is this a component running in a CLI application? |
|
isFrontend ( ) : boolean |
Is this the public section of the component? |
|
isGlobalFOFCacheEnabled ( ) : boolean |
Is the global F0F cache enabled? |
|
loadTranslations ( string $component ) : void |
Load the translation files for a given component. |
|
logDeprecated ( string $message ) : void |
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. |
|
loginUser ( array $authInfo ) : boolean |
logs in a user |
|
logoutUser ( ) : boolean |
logs out a user |
|
runPlugins ( string $event, array $data ) : array |
Execute plugins (system-level triggers) and fetch back an array with
their return values. |
|
setCache ( string $key, string $content ) : boolean |
Saves something to the cache. This is supposed to be used for system-wide
F0F data, not application data. |
|
supportsAjaxOrdering ( ) : boolean |
Is AJAX re-ordering supported? This is 100% Joomla!-CMS specific. All
other platforms should return false and never ask why. |
|