JQueryPlugin Class Reference
[Plugins_generic_jquery]

Plugin to allow jQuery scripts to be added to OCS. More...

Inheritance diagram for JQueryPlugin:

GenericPlugin Plugin List of all members.

Public Member Functions

 addScripts ($baseUrl, $scripts)
 displayCallback ($hookName, $args)
 footerCallback ($hookName, $args)
 getDescription ()
 getDisplayName ()
 getEnabledScripts ($page, $op)
 getName ()
 getScriptPath ()
 isJQueryInstalled ()
 jsEscape ($string)
 register ($category, $path)

Detailed Description

Plugin to allow jQuery scripts to be added to OCS.

Definition at line 23 of file JQueryPlugin.inc.php.


Member Function Documentation

JQueryPlugin.addScripts ( baseUrl,
scripts 
)

Add scripts contained in scripts/ subdirectory to a string to be returned to callback func.

Parameters:
baseUrl string
scripts array All enabled scripts for this page
Returns:
string

Definition at line 145 of file JQueryPlugin.inc.php.

Referenced by displayCallback().

JQueryPlugin.displayCallback ( hookName,
args 
)

Hook callback function for TemplateManager.display

Parameters:
$hookName string
$args array
Returns:
boolean

Definition at line 91 of file JQueryPlugin.inc.php.

References addScripts(), and getEnabledScripts().

Referenced by register().

JQueryPlugin.footerCallback ( hookName,
args 
)

Footer callback to load and display notifications

Definition at line 113 of file JQueryPlugin.inc.php.

Referenced by register().

JQueryPlugin.getDescription (  ) 

Get the description of this plugin

Returns:
string

Definition at line 178 of file JQueryPlugin.inc.php.

References isJQueryInstalled().

JQueryPlugin.getDisplayName (  ) 

Get the display name of this plugin

Returns:
string

Definition at line 170 of file JQueryPlugin.inc.php.

JQueryPlugin.getEnabledScripts ( page,
op 
)

Given a $page and $op, return a list of scripts that should be loaded

Parameters:
$page string The requested page
$op string The requested operation
Returns:
array

Definition at line 62 of file JQueryPlugin.inc.php.

Referenced by displayCallback().

JQueryPlugin.getName (  ) 

Get the symbolic name of this plugin

Returns:
string

Definition at line 162 of file JQueryPlugin.inc.php.

JQueryPlugin.getScriptPath (  ) 

Get the URL for the jQuery script

Returns:
string

Definition at line 52 of file JQueryPlugin.inc.php.

JQueryPlugin.isJQueryInstalled (  ) 

Check whether or not the JQuery library is installed

Returns:
boolean

Definition at line 187 of file JQueryPlugin.inc.php.

Referenced by getDescription(), and register().

JQueryPlugin.register ( category,
path 
)

Register the plugin, if enabled; note that this plugin runs under both Conference and Site contexts.

Parameters:
$category string
$path string
Returns:
boolean

Reimplemented from Plugin.

Definition at line 31 of file JQueryPlugin.inc.php.

References displayCallback(), footerCallback(), and isJQueryInstalled().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7