Class FOFPlatform

Part of the FOF Platform Abstraction Layer. It implements everything that depends on the platform FOF is running under, e.g. the Joomla! CMS front-end, the Joomla! CMS back-end, a CLI Joomla! Platform app, a bespoke Joomla! Platform / Framework web application and so on.

This is the abstract class implementing some basic housekeeping functionality and provides the static interface to get the appropriate Platform object for use in the rest of the framework.

FOFPlatform implements FOFPlatformInterface

Direct known subclasses

FOFIntegrationJoomlaPlatform

Abstract
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/platform/platform.php

Methods summary

`public static`	# `registerPlatformPath( string $path )` Register a path where platform files will be looked for. These take precedence over the built-in platform files. Register a path where platform files will be looked for. These take precedence over the built-in platform files. Parameters `$path` `string` - $path The path to add
`public static`	# `unregisterPlatformPath( string $path )` Unregister a path where platform files will be looked for. Unregister a path where platform files will be looked for. Parameters `$path` `string` - $path The path to remove
`public static`	# `forceInstance( FOFPlatformInterface\|null $instance )` Force a specific platform object to be used. If null, nukes the cache Force a specific platform object to be used. If null, nukes the cache Parameters `$instance` `FOFPlatformInterface\|null` - $instance The Platform object to be used
`public static FOFPlatformInterface`	# `getInstance( )` Find and return the most relevant platform object Find and return the most relevant platform object Returns `FOFPlatformInterface`
`public integer`	# `getOrdering( )` Returns the ordering of the platform class. Returns the ordering of the platform class. Returns `integer` See `FOFPlatformInterface::getOrdering()` Implementation of `FOFPlatformInterface::getOrdering()`
`public boolean`	# `isEnabled( )` Is this platform enabled? Is this platform enabled? Returns `boolean` See `FOFPlatformInterface::isEnabled()` Implementation of `FOFPlatformInterface::isEnabled()`
`public object`	# `getIntegrationObject( string $key )` Returns a platform integration object Returns a platform integration object Parameters `$key` `string` - $key The key name of the platform integration object, e.g. 'filesystem' Returns `object` Since 2.1.2 Implementation of `FOFPlatformInterface::getIntegrationObject()`
`public object`	# `setIntegrationObject( string $key, object $object )` Forces a platform integration object instance Forces a platform integration object instance Parameters `$key` `string` - $key The key name of the platform integration object, e.g. 'filesystem' `$object` `object` - $object The object to force for this key Returns `object` Since 2.1.2 Implementation of `FOFPlatformInterface::setIntegrationObject()`
`public`	# `setErrorHandling( integer $level, string $log_level, array $options = array() )` Set the error Handling, if possible Set the error Handling, if possible Parameters `$level` `integer` - $level PHP error level (E_ALL) `$log_level` `string` - $log_level What to do with the error (ignore, callback) `$options` `array` - $options Options for the error handler Implementation of `FOFPlatformInterface::setErrorHandling()`
`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()` 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 directories for this component. Return a list of the view template directories 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() 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 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 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()` 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()` Implementation of `FOFPlatformInterface::authorizeAdmin()`
`public JDocument`	# `getUser( integer $id = null )` Returns the JUser object for the current user Returns the JUser object for the current user Parameters `$id` `integer` - $id The ID of the user to fetch Returns `JDocument` See `FOFPlatformInterface::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()` Implementation of `FOFPlatformInterface::getDocument()`
`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()` 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()` 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()` 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()` 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()` 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()` 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()` 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()` Implementation of `FOFPlatformInterface::supportsAjaxOrdering()`
`public boolean`	# `checkVersion( string $version1, string $version2, string $operator )` Performs a check between two versions. Use this function instead of PHP version_compare so we can mock it while testing Performs a check between two versions. Use this function instead of PHP version_compare so we can mock it while testing Parameters `$version1` `string` - $version1 First version number `$version2` `string` - $version2 Second version number `$operator` `string` - $operator Operator (see version_compare for valid operators) Returns `boolean` Implementation of `FOFPlatformInterface::checkVersion()`
`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 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 Implementation of `FOFPlatformInterface::getCache()`
`public boolean`	# `isGlobalFOFCacheEnabled( )` Is the global FOF cache enabled? Is the global FOF cache enabled? Returns `boolean` Implementation of `FOFPlatformInterface::isGlobalFOFCacheEnabled()`
`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 Implementation of `FOFPlatformInterface::clearCache()`
`public boolean`	# `loginUser( array $authInfo )` logs in a user logs in a user Parameters `$authInfo` `array` - $authInfo authentification information Returns `boolean` - True on success Implementation of `FOFPlatformInterface::loginUser()`
`public boolean`	# `logoutUser( )` logs out a user logs out a user Returns `boolean` - True on success Implementation of `FOFPlatformInterface::logoutUser()`
`public`	# `logDeprecated( mixed $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` `mixed` - $message The deprecated practice log message Implementation of `FOFPlatformInterface::logDeprecated()`
`public string`	# `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). 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). Returns `string` Since 2.1.2 Implementation of `FOFPlatformInterface::getPlatformName()`
`public string`	# `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. 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. Returns `string` Since 2.1.2 Implementation of `FOFPlatformInterface::getPlatformVersion()`
`public string`	# `getPlatformHumanName( )` Returns the human readable platform name, e.g. "Joomla!", "Joomla! Framework", "Something Something Something Framework" etc. Returns the human readable platform name, e.g. "Joomla!", "Joomla! Framework", "Something Something Something Framework" etc. Returns `string` Since 2.1.2 Implementation of `FOFPlatformInterface::getPlatformHumanName()`

Methods inherited from FOFPlatformInterface

URIbase(), URIroot(), checkExecution(), getConfig(), getDate(), getDbo(), getLanguage(), getPlatformBaseDirs(), logAddLogger(), logDebug(), raiseError(), sendHeaders(), setHeader()

Magic methods summary

Properties summary

`public integer`	`$ordering`	# The ordering for this platform class. The lower this number is, the more important this class becomes. Most important enabled class ends up being used. The ordering for this platform class. The lower this number is, the more important this class becomes. Most important enabled class ends up being used.
`public string`	`$name`	# The internal name of this platform implementation. It must match the last part of the platform class name and be in all lowercase letters, e.g. "foobar" for FOFPlatformFoobar The internal name of this platform implementation. It must match the last part of the platform class name and be in all lowercase letters, e.g. "foobar" for FOFPlatformFoobar Since 2.1.2
`public string`	`$humanReadableName`	# The human readable platform name The human readable platform name Since 2.1.2
`public string`	`$version`	# The platform version string The platform version string Since 2.1.2
`protected boolean`	`$isEnabled`	# Caches the enabled status of this platform class. Caches the enabled status of this platform class.
`protected object`	`$objectCache`	# Filesystem integration objects cache Filesystem integration objects cache Since 2.1.2
`protected static array`	`$paths`	# The list of paths where platform class files will be looked for The list of paths where platform class files will be looked for
`protected static FOFPlatformInterface`	`$instance`	# The platform class instance which will be returned by getInstance The platform class instance which will be returned by getInstance

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFPlatform

Direct known subclasses

Methods summary

Parameters

Parameters

Parameters

Returns

Returns

See

Implementation of

Returns

See

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Returns

See

Implementation of

Returns

See

Implementation of

Returns

See

Implementation of