Collaboration diagram for HTML output:

Functions
	CAS_Client::_htmlFilterOutput ($str)
	This method filters a string by replacing special tokens by appropriate values and prints it. More...

	CAS_Client::printHTMLHeader ($title)
	This method prints the header of the HTML output (after filtering). More...

	CAS_Client::printHTMLFooter ()
	This method prints the footer of the HTML output (after filtering). More...

	CAS_Client::setHTMLHeader ($header)
	This method set the HTML header used for all outputs. More...

	CAS_Client::setHTMLFooter ($footer)
	This method set the HTML footer used for all outputs. More...

Variables
	CAS_Client::$_output_header
	A string used to print the header of HTML pages. More...

	CAS_Client::$_output_footer
	A string used to print the footer of HTML pages. More...

Detailed Description

Function Documentation

◆ _htmlFilterOutput()

CAS_Client::_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 CAS_Client::PrintHTMLHeader() and CAS_Client::printHTMLFooter().

Parameters

string $str the string to filter and output

Returns: void

Definition at line 75 of file Client.php.

    {
        $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;
    }

References CAS_Client\_getServerBaseURL(), CAS_Client\getServerVersion(), and phpCAS\getVersion().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printHTMLFooter()

CAS_Client::printHTMLFooter ( )

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

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

Returns: void

See also: _htmlFilterOutput()

Definition at line 130 of file Client.php.

    {
        $lang = $this->getLangObj();
        $this->_htmlFilterOutput(
            empty($this->_output_footer)?
            (phpcas::getVerbose())?
                '<hr><address>phpCAS __PHPCAS_VERSION__ '
                . $lang->getUsingServer()
                . ' <a href="__SERVER_BASE_URL__">__SERVER_BASE_URL__</a> (CAS __CAS_VERSION__)</a></address></body></html>'
                :'</body></html>'
            :$this->_output_footer
        );
    }

References $lang, CAS_Client\_htmlFilterOutput(), and CAS_Client\getLangObj().

Referenced by CAS_Client\_authError(), CAS_Client\_callback(), CAS_Client\logout(), and CAS_Client\redirectToCas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printHTMLHeader()

CAS_Client::printHTMLHeader ( $title )

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

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

Parameters

string $title the title of the page

Returns: void

See also: _htmlFilterOutput()

Definition at line 101 of file Client.php.

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

References CAS_Client\_htmlFilterOutput().

Referenced by CAS_Client\_authError(), CAS_Client\_callback(), CAS_Client\logout(), and CAS_Client\redirectToCas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHTMLFooter()

CAS_Client::setHTMLFooter ( $footer )

This method set the HTML footer used for all outputs.

Parameters

string $footer the HTML footer.

Returns: void

Definition at line 168 of file Client.php.

    {
        // Argument Validation
        if (gettype($footer) != 'string') {
            throw new CAS_TypeMismatchException($footer, '$footer', 'string');
        }
 
        $this->_output_footer = $footer;
    }

◆ setHTMLHeader()

CAS_Client::setHTMLHeader ( $header )

This method set the HTML header used for all outputs.

Parameters

string $header the HTML header.

Returns: void

Definition at line 151 of file Client.php.

    {
        // Argument Validation
        if (gettype($header) != 'string') {
            throw new CAS_TypeMismatchException($header, '$header', 'string');
        }
 
        $this->_output_header = $header;
    }

Variable Documentation

◆ $_output_footer

CAS_Client::$_output_footer

private

A string used to print the footer of HTML pages.

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

See also: CAS_Client::setHTMLFooter, CAS_Client::printHTMLFooter()

Definition at line 121 of file Client.php.

◆ $_output_header

CAS_Client::$_output_header

private

A string used to print the header of HTML pages.

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

See also: CAS_Client::setHTMLHeader, CAS_Client::printHTMLHeader()

Definition at line 90 of file Client.php.

Functions

Variables

Detailed Description

Function Documentation

◆ _htmlFilterOutput()

◆ printHTMLFooter()

◆ printHTMLHeader()

◆ setHTMLFooter()

◆ setHTMLHeader()

Variable Documentation

◆ $_output_footer

◆ $_output_header