Docs For Class scripts

Class: scripts

Class Overview

This class is used to set JavaScript, JavaScript Files, jQuery JavaScript Libraries and CSS files that need to be loaded either in the header of the footer.

Author(s):

Tom Homer

Methods

Class Details

[line 39]
This class is used to set JavaScript, JavaScript Files, jQuery JavaScript Libraries and CSS files that need to be loaded either in the header of the footer.

Tags:

author:

Tom Homer

Class Methods

constructor __construct [line 66]

scripts __construct(
)

Constructor

This initializes the scriptsobject

[ Top ]

method getFooter [line 432]

string getFooter(
)

Returns JavaScript footer code to be placed just before </body>

Tags:

access:

public

[ Top ]

method getHeader [line 393]

string getHeader(
)

Returns header code (JavaScript and CSS) to include in the Head of the webpage

Tags:

access:

public

[ Top ]

method setCSSFile [line 359]

boolean setCSSFile(
$name
$name, $file
$file, [$constant
$constant = true])

Set CSS file to load

Tags:

access:

public

Parameters:

$name	$name	name of CSS file
$file	$file	location of file relative to public_html directory. Include '/' at beginning
$constant	$constant	Future use. Set to true if file is planned to be loaded all the time (Caching/Compression)

[ Top ]

method setJavaScript [line 246]

boolean setJavaScript(
$script
$script, [$wrap
$wrap = false], [$footer
$footer = true], [$constant
$constant = false])

Set JavaScript to load

Tags:

access:

public

Parameters:

$script	$script	script to include in page
$wrap	$wrap	set to true to place script tags around contents of $script
$footer	$footer	set to true to include script in footer, else script placed in header
$constant	$constant	Future use. Set to true if script is planned to be loaded all the time (Caching/Compression)

[ Top ]

method setJavaScriptFile [line 281]

boolean setJavaScriptFile(
$name
$name, $file
$file, [$footer
$footer = true], [$constant
$constant = false])

Set JavaScript file to load

Tags:

access:

public

Parameters:

$name	$name	name of JavaScript file
$file	$file	location of file relative to public_html directory. Include '/' at beginning
$footer	$footer	set to true to include script in footer, else script placed in header
$constant	$constant	Future use. Set to true if file is planned to be loaded all the time (Caching/Compression)

[ Top ]

method setJavaScriptLibrary [line 190]

boolean setJavaScriptLibrary(
$name
$name)

Set JavaScript Libraries to load

Tags:

access:

public

Parameters:

$name

$name

name of JavaScript library to flag for loading

[ Top ]

Documentation generated on Thu, 24 May 2012 02:08:49 -0400 by phpDocumentor 1.4.3