FoundryLibrary
in package
Unlike the helper, FoundryLibrary needs to be aware of the current extension it is serving.
Table of Contents
Properties
- $appearance : mixed
- $identifiers : mixed
- $paths : mixed
Methods
- __construct() : mixed
- ajax() : mixed
- Renders the ajax library for the extension
- autoload() : mixed
- Renders the autoload file within the extension
- config() : mixed
- Retrieves the configuration of the component
- getActionLog() : mixed
- Creates an instance of the action log library to assist extensions
- getAjaxUrl() : mixed
- Generates the url for Xhr requests
- getAppearance() : mixed
- Determines the current appearance for foundry
- getComponentLibrary() : mixed
- Creates an instance of the component's library
- getComponentName() : mixed
- Retrieves the component's name
- getComponentShortName() : mixed
- Retrieves the component's name
- getDocumentationLink() : mixed
- Retrieves the documentation link for the extension
- getExtensionTitle() : mixed
- Generates the extension name for viewer
- getName() : mixed
- Retrieves the component's name
- getOverridePath() : mixed
- Retrieves the override path for foundry theme files
- getShortName() : mixed
- Retrieves the component's name
- html() : mixed
- Standardized method to load global html tempaltes
- info() : mixed
- Generates the info object that is used by extensions
- js() : mixed
- Retrieves the component's javascript library identifier
- lang() : mixed
- Generates the language prefix for an extension
- loadLanguage() : mixed
- Loads the language for the extension
Properties
$appearance
private
mixed
$appearance
= 'light'
$identifiers
private
mixed
$identifiers
= \null
$paths
private
mixed
$paths
= \null
Methods
__construct()
public
__construct(mixed $component, mixed $componentShortName, mixed $jsName[, mixed $title = '' ][, mixed $options = [] ]) : mixed
Parameters
- $component : mixed
- $componentShortName : mixed
- $jsName : mixed
- $title : mixed = ''
- $options : mixed = []
ajax()
Renders the ajax library for the extension
public
ajax() : mixed
Tags
autoload()
Renders the autoload file within the extension
public
autoload() : mixed
Tags
config()
Retrieves the configuration of the component
public
config() : mixed
Tags
getActionLog()
Creates an instance of the action log library to assist extensions
public
getActionLog() : mixed
Tags
getAjaxUrl()
Generates the url for Xhr requests
public
getAjaxUrl([mixed $useIndex = true ]) : mixed
Parameters
- $useIndex : mixed = true
Tags
getAppearance()
Determines the current appearance for foundry
public
getAppearance() : mixed
Tags
getComponentLibrary()
Creates an instance of the component's library
public
getComponentLibrary(mixed $library) : mixed
Parameters
- $library : mixed
Tags
getComponentName()
Retrieves the component's name
public
getComponentName() : mixed
Tags
getComponentShortName()
Retrieves the component's name
public
getComponentShortName([mixed $uppercase = false ]) : mixed
Parameters
- $uppercase : mixed = false
Tags
getDocumentationLink()
Retrieves the documentation link for the extension
public
getDocumentationLink() : mixed
Tags
getExtensionTitle()
Generates the extension name for viewer
public
getExtensionTitle() : mixed
Tags
getName()
Retrieves the component's name
public
getName() : mixed
Tags
getOverridePath()
Retrieves the override path for foundry theme files
public
getOverridePath() : mixed
Tags
getShortName()
Retrieves the component's name
public
getShortName() : mixed
Tags
html()
Standardized method to load global html tempaltes
public
html(mixed $namespace) : mixed
Parameters
- $namespace : mixed
Tags
info()
Generates the info object that is used by extensions
public
info() : mixed
Tags
js()
Retrieves the component's javascript library identifier
public
js() : mixed
Tags
lang()
Generates the language prefix for an extension
public
lang() : mixed
Tags
loadLanguage()
Loads the language for the extension
public
loadLanguage([mixed $path = JPATH_ROOT ]) : mixed
Parameters
- $path : mixed = JPATH_ROOT