ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
HTML output
+ Collaboration diagram for HTML output:

Functions

 CASClient::HTMLFilterOutput ($str)
 This method filters a string by replacing special tokens by appropriate values and prints it.
 CASClient::printHTMLHeader ($title)
 This method prints the header of the HTML output (after filtering).
 CASClient::printHTMLFooter ()
 This method prints the footer of the HTML output (after filtering).
 CASClient::setHTMLHeader ($header)
 This method set the HTML header used for all outputs.
 CASClient::setHTMLFooter ($footer)
 This method set the HTML footer used for all outputs.

Variables

 CASClient::$_output_header
 A string used to print the header of HTML pages.
 CASClient::$_output_footer
 A string used to print the footer of HTML pages.

Detailed Description

Function Documentation

CASClient::HTMLFilterOutput (   $str)
private

This method filters a string by replacing special tokens by appropriate values and prints it.

The corresponding tokens are taken into account:

  • CAS_VERSION
  • PHPCAS_VERSION
  • SERVER_BASE_URL

Used by CASClient::PrintHTMLHeader() and CASClient::printHTMLFooter().

Parameters
$strthe string to filter and output

Definition at line 81 of file client.php.

References CASClient\getServerBaseURL(), CASClient\getServerVersion(), and phpCAS\getVersion().

Referenced by CASClient\printHTMLFooter(), and CASClient\printHTMLHeader().

{
$str = str_replace('__CAS_VERSION__',$this->getServerVersion(),$str);
$str = str_replace('__PHPCAS_VERSION__',phpCAS::getVersion(),$str);
$str = str_replace('__SERVER_BASE_URL__',$this->getServerBaseURL(),$str);
echo $str;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CASClient::printHTMLFooter ( )
private

This method prints the footer of the HTML output (after filtering).

If CASClient::setHTMLFooter() was not used, a default footer is output.

See Also
HTMLFilterOutput()

Definition at line 136 of file client.php.

References CAS_STR_USING_SERVER, CASClient\getString(), and CASClient\HTMLFilterOutput().

Referenced by CASClient\logout(), and CASClient\redirectToCas().

{
$this->HTMLFilterOutput(empty($this->_output_footer)
?('<hr><address>phpCAS __PHPCAS_VERSION__ '.$this->getString(CAS_STR_USING_SERVER).' <a href="__SERVER_BASE_URL__">__SERVER_BASE_URL__</a> (CAS __CAS_VERSION__)</a></address></body></html>')
:$this->_output_footer);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CASClient::printHTMLHeader (   $title)
private

This method prints the header of the HTML output (after filtering).

If CASClient::setHTMLHeader() was not used, a default header is output.

Parameters
$titlethe title of the page
See Also
HTMLFilterOutput()

Definition at line 108 of file client.php.

References $title, and CASClient\HTMLFilterOutput().

Referenced by CASClient\logout(), and CASClient\redirectToCas().

{
$this->HTMLFilterOutput(str_replace('__TITLE__',
(empty($this->_output_header)
? '<html><head><title>__TITLE__</title></head><body><h1>__TITLE__</h1>'
: $this->_output_header)
)
);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CASClient::setHTMLFooter (   $footer)

This method set the HTML footer used for all outputs.

Parameters
$footerthe HTML footer.

Definition at line 162 of file client.php.

{
$this->_output_footer = $footer;
}
CASClient::setHTMLHeader (   $header)

This method set the HTML header used for all outputs.

Parameters
$headerthe HTML header.

Definition at line 150 of file client.php.

{
$this->_output_header = $header;
}

Variable Documentation

CASClient::$_output_footer
private

A string used to print the footer of HTML pages.

Written by CASClient::setHTMLFooter(), read by printHTMLFooter().

See Also
CASClient::setHTMLFooter, CASClient::printHTMLFooter()

Definition at line 127 of file client.php.

CASClient::$_output_header
private

A string used to print the header of HTML pages.

Written by CASClient::setHTMLHeader(), read by CASClient::printHTMLHeader().

See Also
CASClient::setHTMLHeader, CASClient::printHTMLHeader()

Definition at line 97 of file client.php.