ClarolineScriptEmbed Class Reference

Public Member Functions
	ClarolineScriptEmbed ()
	hideBanner ()
	hideFooter ()
	hideClaroBody ()
	popupMode ()
	frameMode ()
	setContent ($content)
	addHtmlHeader ($header)
	addHttpHeader ($header)
	addBodyOnloadFunction ($function)
	output ()
Static Public Member Functions
	embed ($output, $hide_banner=false, $hide_footer=false, $hide_body=false)
Data Fields
	$inPopup = false
	$inFrame = false
	$inFrameset = false
	$hide_footer = false
	$hide_banner = false
	$hide_body = false
	$content = ''

---

Detailed Description

Claroline script embed class

public

Deprecated:

since Claroline 1.9

Definition at line 66 of file embed.lib.php.

---

Member Function Documentation

addBodyOnloadFunction

(

$

function

)

Add extra javascript executed when body is loaded

public

Parameters:

string

content, page content

Definition at line 187 of file embed.lib.php.

addHtmlHeader

(

$

header

)

Add extra HTML header elements

public

Parameters:

string

content, page content

Definition at line 165 of file embed.lib.php.

addHttpHeader

(

$

header

)

Add extra HTTP header elements

public

Parameters:

string

content, page content

Definition at line 176 of file embed.lib.php.

ClarolineScriptEmbed

(

)

Definition at line 78 of file embed.lib.php.

embed	(	$	output,
		$	hide_banner = false,
		$	hide_footer = false,
		$	hide_body = false
	)			[static]

Embed given contents in Claroline page layout

public

Parameters:

	string	output, content to display in page
	bool	hide_banner, set to true hide Claroline banner
	bool	hide_footer, set to true hide Claroline footer
	bool	hide_body, set to true remove Claroline claroBody div

Todo:

TODO return string instead of echoing it

Definition at line 222 of file embed.lib.php.

frameMode

(

)

Set options to display in a frame

public

Definition at line 132 of file embed.lib.php.

hideBanner

(

)

Hide Claroline banner in display

public

Definition at line 88 of file embed.lib.php.

hideClaroBody

(

)

Hide Claroline claroBody class div in display

public

Definition at line 108 of file embed.lib.php.

hideFooter

(

)

Hide Claroline footer in display

public

Definition at line 98 of file embed.lib.php.

output

(

)

Generate and set output to client

public

Definition at line 198 of file embed.lib.php.

popupMode

(

)

Set options to display in a popup window

public

Definition at line 120 of file embed.lib.php.

setContent

(

$

content

)

Set page content

public

Parameters:

string

content, page content

Definition at line 152 of file embed.lib.php.

---

Field Documentation

$content = ''

Definition at line 74 of file embed.lib.php.

$hide_banner = false

Definition at line 72 of file embed.lib.php.

$hide_body = false

Definition at line 73 of file embed.lib.php.

$hide_footer = false

Definition at line 71 of file embed.lib.php.

$inFrame = false

Definition at line 69 of file embed.lib.php.

$inFrameset = false

Definition at line 70 of file embed.lib.php.

$inPopup = false

Definition at line 68 of file embed.lib.php.

---

The documentation for this class was generated from the following file:

• claroline/claroline/inc/lib/embed.lib.php