Docs For Class HTML

mixed alert(
string
$str, [boolean
$var = false])

A wrapper for alert

Return: PEAR_Error if no script was started or the processed string
Access: public

Parameters:

string	`$str`	—	the string to output
boolean	`$var`	—	set to true if $str is a variable name

[ Top ]

string confirm(
string
$str, string
$assign, [bool
$var = false])

Create a box with yes and no buttons.

In futur releases, the 1st arg will change, $str will always be the 1st argument, $assign the 2nd.

Return: the processed string

Parameters:

string	`$assign`	—	the JS variable to assign the confirmation box to
string	`$str`	—	the string that will appear in the confirmation box
bool	`$var`	—	whether $str is a JS var or not

[ Top ]

mixed endScript(
)

Used to end the script (</script>)

Return: PEAR_Error if no script has been started or the end tag for the script
Access: public

[ Top ]

mixed getOutputMode(
)

Get the output mode for the script

Return: PEAR_Error or true
See: HTML_Javascript::setOutputMode()
Access: public

[ Top ]

mixed popup(
string
$assign, string
$file, string
$title, int
$width, int
$height, mixed
$attr, [int
$top = 300], [int
$left = 300])

A method for easy generation of popup windows

Return: PEAR_Error on error or the processed string.

Parameters:

string	`$assign`	—	the JS var to assign the window to
string	`$file`	—	the file that will appear in the new window
string	`$title`	—	the title of the new window
int	`$width`	—	the width of the window
int	`$height`	—	the height of the window
mixed	`$attr`	—	an array containing the attributes for the new window, each cell can contain either the ints 1/0 or the strings 'yes'/'no'. The order of attributes: resizable, scrollbars, menubar, toolbar, status, location. Can be also a boolean, and then all the attributes are set to yes or no, according to the boolean value.
int	`$top`	—	the distance from the top, in pixels (only used if attr=false\|true).
int	`$left`	—	the distance from the left, in pixels (only used if attr=false\|true).

[ Top ]

the popupWrite(
string
$assign, string
$str, string
$title, int
$width, int
$height, mixed
$attr, [int
$top = 300], [int
$left = 300])

Creates a new popup window containing a string. Inside the popup windows you can access the opener window with the opener var.

Return: processed string
See: HTML_Javascript::popup()

Parameters:

string	`$assign`	—	the JS variable to assign the window to
string	`$str`	—	the string that will appear in the new window (HTML tags would be parsed by the browser, of course)
string	`$title`	—	the title of the window
int	`$width`	—	the width of the window
int	`$height`	—	the height of the window
mixed	`$attr`	—	see popup()
int	`$top`	—	distance from the top (in pixels
int	`$left`	—	distance from the left (in pixels)

[ Top ]

mixed prompt(
string
$str, string
$assign, [string
$default = ''], [string
$var = false])

Open a propmt (input box)

Return: PEAR_Error or the processed string

Parameters:

string	`$str`	—	the string that will appear in the prompt
string	`$assign`	—	the JS var that the input will be assigned to
string	`$default`	—	the default value
string	`$var`	—	wether $str is a JS var or not

[ Top ]

mixed setOutputMode(
[integer
$mode = HTML_JAVASCRIPT_OUTPUT_RETURN], [string
$file = NULL])

Set the output mode for the script

Return: PEAR_Error or true
See: HTML_Javascript::getOutputMode()
Access: public

Parameters:

integer	`$mode`	—	the chosen output mode, can be either HTML_JAVASCRIPT_OUTPUT_RETURN, HTML_JAVASCRIPT_OUTPUT_ECHO or HTML_JAVASCRIPT_OUTPUT_FILE
string	`$file`	—	the path to the file (if $mode is HTML_JAVASCRIPT_OUTPUT_FILE)

[ Top ]

mixed startScript(
[bool
$defer = true])

Starts a new script

Return: a PEAR_Error if a script has been already started or a string (HTML tag <script>)
Access: public

Parameters:

bool $defer — whether to wait for the whole page to load before starting the script or no. Use defer only with script that does not change the document (i.e. alert does not change it).

[ Top ]

mixed write(
string
$str, [boolean
$var = false])

A wrapper for document.writeln

Return: PEAR_Error if no script was started or the processed string
Access: public

Parameters:

string	`$str`	—	the string to output
boolean	`$var`	—	set to true if $str is a variable name

[ Top ]

mixed writeLine(
string
$str, [boolean
$var = false])

A wrapper for document.writeln with an addtional
tag

Return: PEAR_Error if no script was started * or the processed string
Access: public

Parameters:

string	`$str`	—	the string to output
boolean	`$var`	—	set to true if $str is a variable name

[ Top ]

Class: HTML_Javascript

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

alert [line 391]

Parameters:

confirm [line 414]

Parameters:

endScript [line 265]

getOutputMode [line 177]

popup [line 477]

Parameters:

popupWrite [line 523]

Parameters:

prompt [line 439]

Parameters:

setOutputMode [line 154]

Parameters:

startScript [line 246]

Parameters:

write [line 335]

Parameters:

writeLine [line 363]

Parameters: