Class FOFIntegrationJoomlaPlatform

Part of the FOF Platform Abstraction Layer.

This implements the platform class for Joomla! 2.5 or later

FOFPlatform implements FOFPlatformInterface

FOFIntegrationJoomlaPlatform implements FOFPlatformInterface

Package: FrameworkOnFramework\platform
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.1
Located at fof/integration/joomla/platform.php

Methods summary

`public`	# `__construct( )` Public constructor Public constructor
`public boolean`	# `checkExecution( )` Checks if the current script is run inside a valid CMS execution Checks if the current script is run inside a valid CMS execution Returns `boolean` See `FOFPlatformInterface::checkExecution()` Implementation of `FOFPlatformInterface::checkExecution()`
`public mixed`	# `raiseError( integer $code, string $message )` Raises an error, using the logic requested by the CMS (PHP Exception or dedicated class) Raises an error, using the logic requested by the CMS (PHP Exception or dedicated class) Parameters `$code` `integer` - $code `$message` `string` - $message Returns `mixed` Implementation of `FOFPlatformInterface::raiseError()`
`public boolean`	# `isEnabled( )` Is this platform enabled? Is this platform enabled? Returns `boolean` See `FOFPlatformInterface::isEnabled()` Overrides `FOFPlatform::isEnabled` Implementation of `FOFPlatformInterface::isEnabled()`
`protected array`	# `isCliAdmin( )` Main function to detect if we're running in a CLI environment and we're admin Main function to detect if we're running in a CLI environment and we're admin Returns `array` - isCLI and isAdmin. It's not an associtive array, so we can use list.
`public array`	# `getPlatformBaseDirs( )` Returns absolute path to directories used by the CMS. Returns absolute path to directories used by the CMS. Returns `array` - A hash array with keys root, public, admin, tmp and log. See `FOFPlatformInterface::getPlatformBaseDirs()` Implementation of `FOFPlatformInterface::getPlatformBaseDirs()`
`public array`	# `getComponentBaseDirs( string $component )` Returns the base (root) directories for a given component. Returns the base (root) directories for a given component. Parameters `$component` `string` - $component The name of the component. For Joomla! this is something like "com_example" Returns `array` - A hash array with keys main, alt, site and admin. See `FOFPlatformInterface::getComponentBaseDirs()` Overrides `FOFPlatform::getComponentBaseDirs` Implementation of `FOFPlatformInterface::getComponentBaseDirs()`
`public array`	# `getViewTemplatePaths( string $component, string $view, string $layout = 'default', string $tpl = null, boolean $strict = false )` Return a list of the view template paths for this component. Return a list of the view template paths for this component. Parameters `$component` `string` - $component The name of the component. For Joomla! this is something like "com_example" `$view` `string` - $view The name of the view you're looking a template for `$layout` `string` - $layout The layout name to load, e.g. 'default' `$tpl` `string` - $tpl The sub-template name to load (null by default) `$strict` `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. Returns `array` See FOFPlatformInterface::getViewTemplateDirs() Overrides `FOFPlatform::getViewTemplatePaths` Implementation of `FOFPlatformInterface::getViewTemplatePaths()`
`public array`	# `getTemplateSuffixes( )` Get application-specific suffixes to use with template paths. This allows you to look for view template overrides based on the application version. Get application-specific suffixes to use with template paths. This allows you to look for view template overrides based on the application version. Returns `array` - A plain array of suffixes to try in template names Overrides `FOFPlatform::getTemplateSuffixes` Implementation of `FOFPlatformInterface::getTemplateSuffixes()`
`public string`	# `getTemplateOverridePath( string $component, boolean $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. 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. Parameters `$component` `string` - $component The name of the component for which to fetch the overrides `$absolute` `boolean` - $absolute Should I return an absolute or relative path? Returns `string` - The path to the template overrides directory Overrides `FOFPlatform::getTemplateOverridePath` Implementation of `FOFPlatformInterface::getTemplateOverridePath()`
`public`	# `loadTranslations( string $component )` Load the translation files for a given component. Load the translation files for a given component. Parameters `$component` `string` - $component The name of the component. For Joomla! this is something like "com_example" See `FOFPlatformInterface::loadTranslations()` Overrides `FOFPlatform::loadTranslations` Implementation of `FOFPlatformInterface::loadTranslations()`
`public boolean`	# `authorizeAdmin( string $component )` Authorise access to the component in the back-end. Authorise access to the component in the back-end. Parameters `$component` `string` - $component The name of the component. Returns `boolean` - True to allow loading the component, false to halt loading See `FOFPlatformInterface::authorizeAdmin()` Overrides `FOFPlatform::authorizeAdmin` Implementation of `FOFPlatformInterface::authorizeAdmin()`
`public JUser`	# `getUser( integer $id = null )` Return a user object. Return a user object. Parameters `$id` `integer` - $id The user ID to load. Skip or use null to retrieve the object for the currently logged in user. Returns `JUser` - The JUser object for the specified user See `FOFPlatformInterface::getUser()` Overrides `FOFPlatform::getUser` Implementation of `FOFPlatformInterface::getUser()`
`public JDocument`	# `getDocument( )` Returns the JDocument object which handles this component's response. Returns the JDocument object which handles this component's response. Returns `JDocument` See `FOFPlatformInterface::getDocument()` Overrides `FOFPlatform::getDocument` Implementation of `FOFPlatformInterface::getDocument()`
`public JDate`	# `getDate( mixed $time = 'now', null $tzOffest = null, boolean $locale = true )` Returns an object to handle dates Returns an object to handle dates Parameters `$time` `mixed` - $time The initial time `$tzOffest` `null` - $tzOffest The timezone offset `$locale` `boolean` - $locale Should I try to load a specific class for current language? Returns `JDate` - object Implementation of `FOFPlatformInterface::getDate()`
`public`	# `getLanguage( )` Implementation of `FOFPlatformInterface::getLanguage()`
`public FOFDatabaseDriver`	# `getDbo( )` Returns `FOFDatabaseDriver` Implementation of `FOFPlatformInterface::getDbo()`
`public mixed`	# `getUserStateFromRequest( string $key, string $request, FOFInput $input, mixed $default = null, string $type = 'none', boolean $setUserState = true )` This method will try retrieving a variable from the request (input) data. This method will try retrieving a variable from the request (input) data. Parameters `$key` `string` - $key The user state key for the variable `$request` `string` - $request The request variable name for the variable `$input` `FOFInput` - $input The FOFInput object with the request (input) data `$default` `mixed` - $default The default value. Default: null `$type` `string` - $type The filter type for the variable data. Default: none (no filtering) `$setUserState` `boolean` - $setUserState Should I set the user state with the fetched value? Returns `mixed` - The value of the variable See `FOFPlatformInterface::getUserStateFromRequest()` Overrides `FOFPlatform::getUserStateFromRequest` Implementation of `FOFPlatformInterface::getUserStateFromRequest()`
`public`	# `importPlugin( string $type )` Load plugins of a specific type. Obviously this seems to only be required in the Joomla! CMS. Load plugins of a specific type. Obviously this seems to only be required in the Joomla! CMS. Parameters `$type` `string` - $type The type of the plugins to be loaded See `FOFPlatformInterface::importPlugin()` Overrides `FOFPlatform::importPlugin` Implementation of `FOFPlatformInterface::importPlugin()`
`public array`	# `runPlugins( string $event, array $data )` Execute plugins (system-level triggers) and fetch back an array with their return values. Execute plugins (system-level triggers) and fetch back an array with their return values. Parameters `$event` `string` - $event The event (trigger) name, e.g. onBeforeScratchMyEar `$data` `array` - $data A hash array of data sent to the plugins as part of the trigger Returns `array` - A simple array containing the results of the plugins triggered See `FOFPlatformInterface::runPlugins()` Overrides `FOFPlatform::runPlugins` Implementation of `FOFPlatformInterface::runPlugins()`
`public boolean`	# `authorise( string $action, string $assetname )` Perform an ACL check. Perform an ACL check. Parameters `$action` `string` - $action The ACL privilege to check, e.g. core.edit `$assetname` `string` - $assetname The asset name to check, typically the component's name Returns `boolean` - True if the user is allowed this action See `FOFPlatformInterface::authorise()` Overrides `FOFPlatform::authorise` Implementation of `FOFPlatformInterface::authorise()`
`public boolean`	# `isBackend( )` Is this the administrative section of the component? Is this the administrative section of the component? Returns `boolean` See `FOFPlatformInterface::isBackend()` Overrides `FOFPlatform::isBackend` Implementation of `FOFPlatformInterface::isBackend()`
`public boolean`	# `isFrontend( )` Is this the public section of the component? Is this the public section of the component? Returns `boolean` See `FOFPlatformInterface::isFrontend()` Overrides `FOFPlatform::isFrontend` Implementation of `FOFPlatformInterface::isFrontend()`
`public boolean`	# `isCli( )` Is this a component running in a CLI application? Is this a component running in a CLI application? Returns `boolean` See `FOFPlatformInterface::isCli()` Overrides `FOFPlatform::isCli` Implementation of `FOFPlatformInterface::isCli()`
`public boolean`	# `supportsAjaxOrdering( )` Is AJAX re-ordering supported? This is 100% Joomla!-CMS specific. All other platforms should return false and never ask why. Is AJAX re-ordering supported? This is 100% Joomla!-CMS specific. All other platforms should return false and never ask why. Returns `boolean` See `FOFPlatformInterface::supportsAjaxOrdering()` Overrides `FOFPlatform::supportsAjaxOrdering` Implementation of `FOFPlatformInterface::supportsAjaxOrdering()`
`public boolean`	# `isGlobalFOFCacheEnabled( )` Is the global FOF cache enabled? Is the global FOF cache enabled? Returns `boolean` Overrides `FOFPlatform::isGlobalFOFCacheEnabled` Implementation of `FOFPlatformInterface::isGlobalFOFCacheEnabled()`
`public boolean`	# `setCache( string $key, string $content )` Saves something to the cache. This is supposed to be used for system-wide FOF data, not application data. Saves something to the cache. This is supposed to be used for system-wide FOF data, not application data. Parameters `$key` `string` - $key The key of the data to save `$content` `string` - $content The actual data to save Returns `boolean` - True on success Overrides `FOFPlatform::setCache` Implementation of `FOFPlatformInterface::setCache()`
`public string`	# `getCache( string $key, string $default = null )` Retrieves data from the cache. This is supposed to be used for system-side FOF data, not application data. Retrieves data from the cache. This is supposed to be used for system-side FOF data, not application data. Parameters `$key` `string` - $key The key of the data to retrieve `$default` `string` - $default The default value to return if the key is not found or the cache is not populated Returns `string` - The cached value Overrides `FOFPlatform::getCache` Implementation of `FOFPlatformInterface::getCache()`
`public boolean`	# `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. 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. Returns `boolean` - True on success Overrides `FOFPlatform::clearCache` Implementation of `FOFPlatformInterface::clearCache()`
`public mixed`	# `getConfig( )` Returns an object that holds the configuration of the current site. Returns an object that holds the configuration of the current site. Returns `mixed` Implementation of `FOFPlatformInterface::getConfig()`
`public boolean`	# `loginUser( array $authInfo )` logs in a user logs in a user Parameters `$authInfo` `array` - $authInfo authentification information Returns `boolean` - True on success Overrides `FOFPlatform::loginUser` Implementation of `FOFPlatformInterface::loginUser()`
`public boolean`	# `logoutUser( )` logs out a user logs out a user Returns `boolean` - True on success Overrides `FOFPlatform::logoutUser` Implementation of `FOFPlatformInterface::logoutUser()`
`public`	# `logAddLogger( mixed $file )` Implementation of `FOFPlatformInterface::logAddLogger()`
`public`	# `logDeprecated( string $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. 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. Parameters `$message` `string` - $message The deprecated practice log message Overrides `FOFPlatform::logDeprecated` Implementation of `FOFPlatformInterface::logDeprecated()`
`public`	# `logDebug( mixed $message )` Implementation of `FOFPlatformInterface::logDebug()`
`public string`	# `URIroot( boolean $pathonly = false, string $path = null )` Returns the root URI for the request. Returns the root URI for the request. Parameters `$pathonly` `boolean` - $pathonly If false, prepend the scheme, host and port information. Default is false. `$path` `string` - $path The path Returns `string` - The root URI string. Implementation of `FOFPlatformInterface::URIroot()`
`public string`	# `URIbase( boolean $pathonly = false )` Returns the base URI for the request. Returns the base URI for the request. Parameters `$pathonly` `boolean` - $pathonly If false, prepend the scheme, host and port information. Default is false. \| Returns `string` - The base URI string Implementation of `FOFPlatformInterface::URIbase()`
`public`	# `setHeader( string $name, string $value, boolean $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) 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) Parameters `$name` `string` - $name The name of the header to set. `$value` `string` - $value The value of the header to set. `$replace` `boolean` - $replace True to replace any headers with the same name. Implementation of `FOFPlatformInterface::setHeader()`
`public`	# `sendHeaders( )` In platforms that perform header caching, send all headers. In platforms that perform header caching, send all headers. Implementation of `FOFPlatformInterface::sendHeaders()`

Methods inherited from FOFPlatform

checkVersion(), forceInstance(), getInstance(), getIntegrationObject(), getOrdering(), getPlatformHumanName(), getPlatformName(), getPlatformVersion(), registerPlatformPath(), setErrorHandling(), setIntegrationObject(), unregisterPlatformPath()

Magic methods summary

Properties summary

Properties inherited from FOFPlatform

$humanReadableName, $instance, $isEnabled, $name, $objectCache, $ordering, $paths, $version

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFIntegrationJoomlaPlatform

Methods summary

Returns

See

Implementation of

Parameters

Returns

Implementation of

Returns

See

Overrides

Implementation of

Returns

Returns

See

Implementation of

Parameters

Returns

See

Overrides

Implementation of

Parameters

Returns

See

Overrides

Implementation of

Returns

Overrides

Implementation of

Parameters

Returns

Overrides

Implementation of

Parameters

See

Overrides

Implementation of

Parameters

Returns

See

Overrides

Implementation of

Parameters

Returns

See

Overrides

Implementation of

Returns

See

Overrides

Implementation of

Parameters

Returns

Implementation of

Implementation of

Returns

Implementation of

Parameters

Returns

See

Overrides

Implementation of

Parameters

See

Overrides

Implementation of

Parameters

Returns

See

Overrides

Implementation of

Parameters

Returns

See