• 홈
• FOF30
• Platform
• PlatformInterface

PHP 인터페이스 FOF30\Platform\PlatformInterface

파일 보기 프로젝트 열기: akeeba/fof

공개 메소드들

메소드	설명
URIbase ( boolean $pathonly = false ) : string	Returns the base URI for the request.
URIroot ( boolean $pathonly = false, string $path = null ) : string	Returns the root URI for the request.
__construct ( Container $c )	Public constructor.
authorise ( string $action, string $assetname ) : boolean	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.
authorizeAdmin ( string $component ) : boolean	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.
checkExecution ( ) : boolean	Checks if the current script is run inside a valid CMS execution
clearCache ( ) : boolean	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 F0F. Please note that FOF's cache never expires and is not purged by Joomla!. You MUST use this method to manually purge the cache.
closeApplication ( integer $code ) : void	Immediately terminate the containing application's execution
getCache ( string $key, string $default = null ) : string	Retrieves data from the cache. This is supposed to be used for system-side FOF data, not application data.
getComponentBaseDirs ( string $component ) : array	Returns the base (root) directories for a given component, i.e the application which is running inside our main application (CMS, web app).
getConfig ( ) : JRegistry	Returns an object that holds the configuration of the current site.
getDate ( mixed $time = 'now', null $tzOffest = null, boolean $locale = true ) : JDate	Returns an object to handle dates
getDbo ( ) : JDatabaseDriver	Returns the database driver object of the CMS/application
getDocument ( ) : JDocument	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.
getLanguage ( ) : JLanguage	Return the \JLanguage instance of the CMS/application
getPlatformBaseDirs ( ) : array	Returns absolute path to directories used by the containing CMS/application.
getPlatformVersion ( ) : string	Returns the version number string of the CMS/application we're running in
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 ) : JUser	Returns a user object.
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 itself.
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 FOF cache enabled?
loadTranslations ( string $component ) : void	Load the translation files for a given component.
logAddLogger ( string $file ) : void	Add a log file for FOF
logDebug ( string $message ) : void	Adds a message to the application's debug log
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
raiseError ( integer $code, string $message ) : mixed	Raises an error, using the logic requested by the CMS (PHP Exception or dedicated class)
runPlugins ( string $event, array $data ) : array	Execute plugins (system-level triggers) and fetch back an array with their return values.
sendHeaders ( ) : void	In platforms that perform header caching, send all headers.
setCache ( string $key, string $content ) : boolean	Saves something to the cache. This is supposed to be used for system-wide FOF data, not application data.
setHeader ( string $name, string $value, boolean $replace = false ) : void	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)
supportsAjaxOrdering ( ) : boolean	Is AJAX re-ordering supported? This is 100% Joomla! CMS (version 3+) specific.

메소드 상세