class CAppPlugins extends JObject


Located at : UKNOWVA_ROOT/components/com_community/libraries/apps.php

Properties

$name
$triggerCount

Methods

__construct($name)

Class constructor, overridden in descendant classes.

string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get($pluginsName = '', $id, $params = array())

Return the plugin object

array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
getInstance()

No description

loadApplications()

Used to include specific applications that are enabled on specific users.

_getPlgFromDispatcher($appName)

No description

renderPlugin($plgObj, $userid)

No description

triggerPlugin($triggerName, $pluginName, $userid)

Trigger a single plugin, support only onProfileDisplay for now

_triggerOnProfileDisplay($event = 'onProfileDisplay')

Used to trigger profile display event

_triggerOnFormDisplay(string $event, array $arrayParams)

Used to trigger onFormDisplay event trigger.

triggerEvent(string $event, array $arrayParams = null, bool $needOrdering = false)

Used to trigger applications

loadAjaxPlugins()

Method to include the ajax function names

ajax()

Calls the plugins AJAX methods

showAbout($appName)

No description

removeApp($userid, $appName)

No description

showPrivacy($appName)

No description

showConfig($pluginsName, $params = array())

Get config html from the xml file

loadConfig($pluginsName, $params = array())

Load and return the $param object for the given plugin

isInstalled($userid, $appname)

Return true if the apps is already installed by the given user

loadLanguage($extension = '', $basePath = JPATH_ADMINISTRATOR)

No description

Details

at line 20
JObject __construct($name)

Class constructor, overridden in descendant classes.

Parameters

$name

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

at line 370
mixed get($pluginsName = '', $id, $params = array())

Return the plugin object

Parameters

$pluginsName
$id
$params

Return Value

mixed The value of the property.

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

at line 29
getInstance()

at line 41
loadApplications()

Used to include specific applications that are enabled on specific users.

So that the page will be optimized because files will not be included.

at line 54
_getPlgFromDispatcher($appName)

Parameters

$appName

at line 76
renderPlugin($plgObj, $userid)

Parameters

$plgObj
$userid

at line 116
triggerPlugin($triggerName, $pluginName, $userid)

Trigger a single plugin, support only onProfileDisplay for now

Parameters

$triggerName
$pluginName
$userid

at line 149
_triggerOnProfileDisplay($event = 'onProfileDisplay')

Used to trigger profile display event

Parameters

$event

at line 229
_triggerOnFormDisplay(string $event, array $arrayParams)

Used to trigger onFormDisplay event trigger.

Parameters

string $event eventName (will always be 'onFormDisplay')
array $arrayParams params to pass to the function

returns Array result An array of CFormElement objects.

at line 266
triggerEvent(string $event, array $arrayParams = null, bool $needOrdering = false)

Used to trigger applications

Parameters

string $event eventName
array $arrayParams params to pass to the function
bool $needOrdering do we need to use custom user ordering ?

returns Array An array of object that the caller can then manipulate later.

at line 323
loadAjaxPlugins()

Method to include the ajax function names

at line 360
ajax()

Calls the plugins AJAX methods

at line 401
showAbout($appName)

Parameters

$appName

at line 420
removeApp($userid, $appName)

Parameters

$userid
$appName

at line 429
showPrivacy($appName)

Parameters

$appName

at line 451
showConfig($pluginsName, $params = array())

Get config html from the xml file

Parameters

$pluginsName
$params

at line 458
loadConfig($pluginsName, $params = array())

Load and return the $param object for the given plugin

Parameters

$pluginsName
$params

at line 464
isInstalled($userid, $appname)

Return true if the apps is already installed by the given user

Parameters

$userid
$appname

at line 469
loadLanguage($extension = '', $basePath = JPATH_ADMINISTRATOR)

Parameters

$extension
$basePath