response_http_html Class Reference

Inheritance diagram for response_http_html:

Public Member Functions
	getTitle ()
	setTitle ($title)
	addTitleBefore ($title, $sep=', ')
	addTitleAfter ($title, $sep=', ')
	getMeta ($name)
	setMeta ($name, $value)
	getLink ($rel)
	setLink ($rel, array $attributes)
	setMetaBefore ($name, $value, $sep=', ')
	setMetaAfter ($name, $value, $sep=', ')
	add (array $prm)
	getIncFiles ()
	getDepend ($file, $type='js', $after=false)
	addJs ($prm)
	addCss ($prm)
	block ($block, $type='js', $first=false)
	blockJs ($block, $first=false)
	blockjQuery ($block)
	blockCss ($block, $first=false)
	getHtmlElt ($prm='all', $ln="\n")
	getIncludeTagFile ($type, $files, $dir='nyro', $media='screen')
	getUrlFile ($type, $files, $dir='nyro')
	getHtmlBlocks ($type, $ln="\n")
	send ($headerOnly=false)
	getStatus ($name=false)
	setStatus ($status)
	getCompress ()
	setCompress ($compress)
	getLayout ()
	setlayout ($layout)
	getAjaxLayout ()
	setAjaxlayout ($ajaxLayout)
	addHeader ($name, $value, $replace=true)
	setContentType ($value, $replace=true)
	neverExpire ()
	getHeader ($name=null)
	hasHeader ($name)
	clearHeaders ()
	sendHeaders ()
	addBeforeOut ($callback)
	send ()
	sendText ($text)
	sendFile ($file, $name=null)
	showFile ($file)
	comment ($comment)
	redirect ($url, $status=301)
	error ($url=null, $number=404)
	getProxy ()
	getContent ()
	setContent ($content)
	__call ($func, $prm)
	__toString ()
	getAttr ($name)
	setAttr ($name, $value)
	getCfg ()
Protected Member Functions
	afterInit ()
	initBlocks ($type)
	setHtmlEltIntern ($content)
	getHtmlMeta ($ln="\n")
	getHtmlIncFiles ($type, $ln="\n")
	beforeOut ()
	beforeInit ()
Protected Attributes
	$incFiles
	$blocks = array()
	$blocksJquery = array()
	$headers
	$beforeOut = array()
	$content
	$proxy = null
	$cfg

Detailed Description

HTML Response Provide functions to manage the head parts

Definition at line 11 of file html.class.php.

Member Function Documentation

__call	(	$	func,
		$	prm
	)			`[inherited]`

Here to avoid wrong call to the response object

Definition at line 78 of file response/abstract.class.php.

__toString ( ) [inherited]

Definition at line 80 of file response/abstract.class.php.

add ( array $ prm )

Add an include file

Parameters:

array

$prm Same parameter as addCss or addJs, with adding:

string type File type (js or css) (required)

Returns:: bool True if addedor already added, False if not found

Exceptions:

nExecption

if type or file not provided

See also:: addJs, addCss

Definition at line 169 of file html.class.php.

addBeforeOut ( $ callback ) [inherited]

Add a callback before the out

Parameters:

callback

$callback

Definition at line 205 of file http.class.php.

addCss ( $ prm )

Add an CSS file

Parameters:

array

$prm Filename or parameter for the css file. Available keys are:

string file: filename (required)
string dir: Where include the file (possible values: nyro, web, or nyroLast)
string media: Media attribute
string condIE: special string to include CSS for IE
bool verifExists: indicate if the file should exist to be included

Returns:: bool True if added or already added, False if not found

See also:: add

Definition at line 300 of file html.class.php.

addHeader	(	$	name,
		$	value,
		$	replace = `true`
	)			`[inherited]`

Add a http header to the response

Parameters:

	string	$name Header name
	mixed	$value Header value
	bool	$replace True if replacement forced

Returns:: bool True if header added

Definition at line 119 of file http.class.php.

addJs ( $ prm )

Add an javascript file

Parameters:

string|array

$prm Filename or parameter for the css file. Available keys are:

string file: filename (required)
string dir: Where include the file (possible values: nyro, web, or nyroLast)
bool verifExists: indicate if the file should exist to be included

Returns:: bool True if added, False if not found or already added

See also:: add

Definition at line 281 of file html.class.php.

addTitleAfter	(	$	title,
		$	sep = `'`,
		'
	)

Add a string after the acual title, with a spearator if needed

Parameters:

	string	$title
	string	$sep

Definition at line 80 of file html.class.php.

addTitleBefore	(	$	title,
		$	sep = `'`,
		'
	)

Add a string before the acual title, with a spearator if needed

Parameters:

	string	$title
	string	$sep

Definition at line 70 of file html.class.php.

afterInit ( ) [protected]

Call just after the configuration initialisation

Reimplemented from response_http.

Reimplemented in response_http_xul.

Definition at line 34 of file html.class.php.

beforeInit ( ) [protected, inherited]

Call just before the configuration initialisation

Reimplemented in form_file.

Definition at line 35 of file object.class.php.

beforeOut ( ) [protected, inherited]

Execute the before out callbacks

Definition at line 212 of file http.class.php.

block	(	$	block,
		$	type = `'js'`,
		$	first = `false`
	)

Add a block

Parameters:

	string	$block The block
	string	$type the block type (js or css)
	bool	$first True if needed to be placed on the first place

Returns:: bool True if added

Definition at line 315 of file html.class.php.

blockCss	(	$	block,
		$	first = `false`
	)

Add a CSS block

Parameters:

	string	$block The CSS block
	bool	$first True if needed to be placed on the first place

Returns:: bool True if added

See also:: block

Definition at line 357 of file html.class.php.

blockjQuery ( $ block )

Add a jQuery block

Parameters:

string

$block The javascript block

See also:: blockJs

Definition at line 344 of file html.class.php.

blockJs	(	$	block,
		$	first = `false`
	)

Add a javascript block

Parameters:

	string	$block The javascript block
	bool	$first True if needed to be placed on the first place

Returns:: bool True if added

See also:: block

Definition at line 334 of file html.class.php.

clearHeaders ( ) [inherited]

Clear the header by reaffecting the default values, provided in the config

Definition at line 183 of file http.class.php.

comment ( $ comment ) [inherited]

Return the content commented regarding the request type

Parameters:

string

$comment

Returns:: string

Reimplemented from response_abstract.

Definition at line 308 of file http.class.php.

error	(	$	url = `null`,
		$	number = `404`
	)			`[inherited]`

Redirect with an error the user

Parameters:

	string	$url The url where to redirect
	int	$number The HTTP error number

Definition at line 345 of file http.class.php.

getAjaxLayout ( ) [inherited]

Get the ajax layout will be used

Returns:: string

Definition at line 98 of file http.class.php.

getAttr ( $ name ) [inherited]

Get an attribute

Parameters:

string

$name Attribute name

Returns:: mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

getCfg ( ) [inherited]

Get the configuration object

Returns:: config

Definition at line 67 of file object.class.php.

getCompress ( ) [inherited]

Check if the compress mode is activate

Returns:: bool

Definition at line 62 of file http.class.php.

getContent ( ) [inherited]

Get the response content

Returns:: mixed

Definition at line 40 of file response/abstract.class.php.

getDepend	(	$	file,
		$	type = `'js'`,
		$	after = `false`
	)

Get the dependancies for a file

Parameters:

	string	$file File name
	string	$type File type (js or css)

Returns:: array

Definition at line 257 of file html.class.php.

getHeader ( $ name = null ) [inherited]

Get a header value

Parameters:

string|null

$name Header name or null to get all of them

Returns:: mixed|null The header value or null if not set

Definition at line 162 of file http.class.php.

getHtmlBlocks	(	$	type,
		$	ln = `"\n"`
	)

Get the HTML blocks

Parameters:

	string	$type Docuement type (css or js)
	string	$ln New line character

Returns:: string

Definition at line 529 of file html.class.php.

getHtmlElt	(	$	prm = `'all'`,
		$	ln = `"\n"`
	)

Get the HTML Head part requested or all (title, meta and included files). This function will only return a placeholder that will be overwritten at the very end, just before the content is send.

Parameters:

	string	$prm The requested part (title, meta or incFiles)
	string	$ln New line character

Returns:: string The requested HTML part

Definition at line 370 of file html.class.php.

getHtmlIncFiles	(	$	type,
		$	ln = `"\n"`
	)			`[protected]`

Get the HTML included files

Parameters:

	string	$type Docuement type (css or js)
	string	$ln New line character

Returns:: string

Definition at line 444 of file html.class.php.

getHtmlMeta ( $ ln = "\n" ) [protected]

Get the HTML Meta

Parameters:

string

$ln New line character

Returns:: string

Definition at line 419 of file html.class.php.

getIncFiles ( )

Get the included files

Returns:: array

Definition at line 246 of file html.class.php.

getIncludeTagFile	(	$	type,
		$	files,
		$	dir = `'nyro'`,
		$	media = `'screen'`
	)

Get the tag to include an external file.

Parameters:

	string	$type (css\|js)
	array\|string	$files List of files or a single file path
	string	$dir Where to get the file (nyro\|web)
	string	$media Media info for css only

Returns:: string

Definition at line 498 of file html.class.php.

getLayout ( ) [inherited]

Get the layout will be used

Returns:: string

Definition at line 80 of file http.class.php.

getLink ( $ rel )

Get a link content

Parameters:

string

$rel Rel name

Returns:: array|null

Definition at line 110 of file html.class.php.

getMeta ( $ name )

Get a meta content

Parameters:

string

$name Meta name

Returns:: string|null

Definition at line 90 of file html.class.php.

getProxy ( ) [inherited]

Get the response proxy (used in the templates)

Returns:: responseProxy

Definition at line 31 of file response/abstract.class.php.

getStatus ( $ name = false ) [inherited]

Get the response status

Parameters:

bool

$name True if the return should be the name instead of the code status

Returns:: int|string

Definition at line 36 of file http.class.php.

getTitle ( )

Get the title

Returns:: string|null

Definition at line 51 of file html.class.php.

getUrlFile	(	$	type,
		$	files,
		$	dir = `'nyro'`
	)

Get an URL for a CSS or JS file.

Parameters:

	string	$type (css\|js)
	array\|string	$files List of files or a single file path
	string	$dir Where to get the file (nyro\|web)

Returns:: string

Definition at line 512 of file html.class.php.

hasHeader ( $ name ) [inherited]

Check if a header is set

Parameters:

string

$name Header name

Returns:: bool

Definition at line 176 of file http.class.php.

initBlocks ( $ type ) [protected]

Initialize the blocks array for the requested type

Parameters:

string

$type

Definition at line 155 of file html.class.php.

neverExpire ( ) [inherited]

Make the response to expire in 32 days

Definition at line 152 of file http.class.php.

redirect	(	$	url,
		$	status = `301`
	)			`[inherited]`

Redirect the user with a header content

Parameters:

	string	$url
	int	$status

Definition at line 330 of file http.class.php.

send ( ) [abstract, inherited]

Send The response

send ( $ headerOnly = false )

Send The response

Parameters:

bool

$headerOnly Send only the header and exit

Reimplemented from response_http.

Definition at line 543 of file html.class.php.

sendFile	(	$	file,
		$	name = `null`
	)			`[inherited]`

Send a file for download

Parameters:

	string	$file File Path
	null\|string	$name File name. If not provided, the real filname will be used

Definition at line 267 of file http.class.php.

sendHeaders ( ) [inherited]

Send HTTP headers and cookies.

Definition at line 190 of file http.class.php.

sendText ( $ text ) [inherited]

Send a text response (exit the programm)

Parameters:

string

$text

Reimplemented from response_abstract.

Definition at line 254 of file http.class.php.

setAjaxlayout ( $ ajaxLayout ) [inherited]

Set a new ajax layout to use

Parameters:

string

$ajaxLayout

Definition at line 107 of file http.class.php.

setAttr	(	$	name,
		$	value
	)			`[inherited]`

Set an attribute

Parameters:

	string	$name Attribute name
	mixed	$value Attribute value

Definition at line 58 of file object.class.php.

setCompress ( $ compress ) [inherited]

Activate or desactivate the compress mode

Parameters:

bool

$compress

Definition at line 71 of file http.class.php.

setContent ( $ content ) [inherited]

set the response content

Parameters:

mixed

$content

Definition at line 49 of file response/abstract.class.php.

setContentType	(	$	value,
		$	replace = `true`
	)			`[inherited]`

Set the content type Header of the response

Parameters:

	string	$value The content type wanted (ie: html, js) (if not know in contentTypeCfg, it will be text/$value)
	bool	$replace Indicate if the content-type could overwrite the current one

Returns:: bool True if the content-type was set

See also:: setHeader

Definition at line 137 of file http.class.php.

setHtmlEltIntern ( $ content ) [protected]

Used by the send function to replace place holders set by getHtmlelt by actual content

Parameters:

string

$content

Returns:: string

Definition at line 400 of file html.class.php.

setlayout ( $ layout ) [inherited]

Set a new layout to use

Parameters:

string

$layout

Definition at line 89 of file http.class.php.

setLink	(	$	rel,
		array $	attributes
	)

Set a link content

Parameters:

	string	$rel Rel name
	array	$attributes Link attributes

Definition at line 120 of file html.class.php.

setMeta	(	$	name,
		$	value
	)

Set a meta content

Parameters:

	string	$name Meta name
	string	$value Meta content

Definition at line 100 of file html.class.php.

setMetaAfter	(	$	name,
		$	value,
		$	sep = `'`,
		'
	)

Add a string after the acual meta, with a spearator if needed

Parameters:

	string	$name Meta Name
	string	$value Meta content
	string	$sep

Definition at line 144 of file html.class.php.

setMetaBefore	(	$	name,
		$	value,
		$	sep = `'`,
		'
	)

Add a string before the acual meta, with a spearator if needed

Parameters:

	string	$name Meta Name
	string	$value Meta content
	string	$sep

Definition at line 131 of file html.class.php.

setStatus ( $ status ) [inherited]

Set the reponse status by code

Parameters:

int

$status

Returns:: bool True if succesful

Definition at line 49 of file http.class.php.

setTitle ( $ title )

Set the title

Parameters:

string

$title

Definition at line 60 of file html.class.php.

showFile ( $ file ) [inherited]

Show a file to the client

Parameters:

string

$file File Path

Definition at line 289 of file http.class.php.

Field Documentation

$beforeOut = array() [protected, inherited]

Definition at line 24 of file http.class.php.

$blocks = array() [protected]

Definition at line 25 of file html.class.php.

$blocksJquery = array() [protected]

Definition at line 32 of file html.class.php.

$cfg [protected, inherited]

Definition at line 17 of file object.class.php.

$content [protected, inherited]

Definition at line 17 of file response/abstract.class.php.

$headers [protected, inherited]

Definition at line 17 of file http.class.php.

$incFiles [protected]

Definition at line 18 of file html.class.php.

$proxy = null [protected, inherited]

Definition at line 24 of file response/abstract.class.php.

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

html.class.php

response_http_html Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Field Documentation