PHP Class CampHTMLDocument

Afficher le fichier Open project: sourcefabric/newscoop Class Usage Examples

Méthodes publiques

Méthode Description
getCharset ( ) : string Returns the charset.
getGenerator ( ) : string Returns the page generator.
getMetaTag ( string $p_name, boolean $p_httpEquiv = false ) : string Returns the requested META tag.
getMimeType ( ) : string Returns the MIME type.
getTitle ( ) : string Returns the title of the document.
getType ( ) : string Returns the type of document.
render ( array $p_params ) : void Renders the document.
setCharset ( string $p_charset = 'utf-8' ) : void Sets the charset.
setMetaTag ( string $p_name, mixed $p_value, boolean $p_httpEquiv = false ) : void Sets the given META tag.
setMimeType ( string $p_mime = 'text/html' ) : void Sets the MIME type for the document.
setTitle ( string $p_title = null ) : void Sets the document title.
singleton ( array $p_attributes = [] ) : object Builds an instance object of this class only if there is no one.

Private Methods

Méthode Description
__construct ( array $p_attributes = [] ) Class constructor
templateExists ( string $template, Smarty $smarty ) : boolean Test if template exists

Method Details

getCharset() public méthode

Returns the charset.
public getCharset ( ) : string
Résultat string

getGenerator() public méthode

Returns the page generator.
public getGenerator ( ) : string
Résultat string

getMetaTag() public méthode

Returns the requested META tag.
public getMetaTag ( string $p_name, boolean $p_httpEquiv = false ) : string
$p_name string The name of the META tag to be retrieved
$p_httpEquiv boolean Whether it is a http-equiv META tag or not
Résultat string $tag

getMimeType() public méthode

Returns the MIME type.
public getMimeType ( ) : string
Résultat string

getTitle() public méthode

Returns the title of the document.
public getTitle ( ) : string
Résultat string

getType() public méthode

Returns the type of document.
public getType ( ) : string
Résultat string

render() public méthode

Displays the document after parsing it.
public render ( array $p_params ) : void
$p_params array
Résultat void

setCharset() public méthode

Sets the charset.
public setCharset ( string $p_charset = 'utf-8' ) : void
$p_charset string
Résultat void

setMetaTag() public méthode

Sets the given META tag.
public setMetaTag ( string $p_name, mixed $p_value, boolean $p_httpEquiv = false ) : void
$p_name string The name of the META tag to be retrieved
$p_value mixed The value for the META tag
$p_httpEquiv boolean Whether it is a http-equiv META tag or not
Résultat void

setMimeType() public méthode

Sets the MIME type for the document.
public setMimeType ( string $p_mime = 'text/html' ) : void
$p_mime string
Résultat void

setTitle() public méthode

Sets the document title.
public setTitle ( string $p_title = null ) : void
$p_title string
Résultat void

singleton() public static méthode

Builds an instance object of this class only if there is no one.
public static singleton ( array $p_attributes = [] ) : object
$p_attributes array
Résultat object