ClaroHeader Class Reference

Inheritance diagram for ClaroHeader:
CoreTemplate PhpTemplate Display

Public Member Functions

 __construct ()
 setTitle ($pageTitle)
 setToolName ($pageTitle)
 addHtmlHeader ($header)
 addInlineJavascript ($script)
 addInlineStyle ($style)
 addHttpHeader ($header)
 sendHttpHeaders ()
 render ()

Static Public Member Functions

static getInstance ()

Private Member Functions

 _globalVarsCompat ()

Private Attributes

 $_htmlXtraHeaders
 $_httpXtraHeaders
 $_toolName

Static Private Attributes

static $instance = false

Detailed Description

Definition at line 24 of file header.lib.php.


Constructor & Destructor Documentation

__construct (  ) 

Constructor

Definition at line 35 of file header.lib.php.


Member Function Documentation

_globalVarsCompat (  )  [private]

Retrieve variables used by the old header script for compatibility with old scripts

Definition at line 146 of file header.lib.php.

addHtmlHeader ( header  ) 

Add extra HTML header elements

Parameters:
string $header header to add

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

addHttpHeader ( header  ) 

Add extra HTTP header elements

Parameters:
string $header HTTP header

Definition at line 118 of file header.lib.php.

addInlineJavascript ( script  ) 

Add inline javascript code to HTML head

Parameters:
string $script javascript code

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

addInlineStyle ( style  ) 

Add inline css style to HTML head

Parameters:
string $style css style

Definition at line 103 of file header.lib.php.

static getInstance (  )  [static]

Definition at line 43 of file header.lib.php.

render (  ) 

Render the HTML page header

Returns:
string

Reimplemented from PhpTemplate.

Definition at line 169 of file header.lib.php.

sendHttpHeaders (  ) 

Send HTTP headers to the client

Definition at line 126 of file header.lib.php.

setTitle ( pageTitle  ) 

Set the page title

Since:
Claroline 1.9.5
Parameters:
string $title

Definition at line 58 of file header.lib.php.

setToolName ( pageTitle  ) 

Set the page title

Deprecated:
since Claroline 1.9.5, use setTitle() instead
Parameters:
string $pageTitle

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


Field Documentation

$_htmlXtraHeaders [private]

Definition at line 28 of file header.lib.php.

$_httpXtraHeaders [private]

Definition at line 29 of file header.lib.php.

$_toolName [private]

Definition at line 30 of file header.lib.php.

$instance = false [static, private]

Definition at line 26 of file header.lib.php.


The documentation for this class was generated from the following file:
Generated on Tue Jun 8 12:28:38 2010 for Claroline API by  doxygen 1.6.3