Inheritance diagram for response_http_xul:

Public Member Functions
	initIncFiles ($addDefaults=true)

	getTitle ()

	setTitle ($title)

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

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

	setTitleInDes ($titleInDes)

	getMeta ($name)

	setMeta ($name, $value)

	getMetaProperty ($name)

	setMetaProperty ($name, $value)

	getLink ($rel)

	setLink ($rel, array $attributes)

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

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

	setMetaPropertyBefore ($name, $value, $sep=', ')

	setMetaPropertyAfter ($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, $addjQuery=true)

	blockCss ($block, $first=false)

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

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

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

	getHtmlBlocks ($type, $ln="\)

	send ($headerOnly=false)

	send ()

	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)

	canGlobalCache ()

	getVarsForGlobalCache ()

	setVarsFromGlobalCache ($vars)

	sendText ($text)

	sendFile ($file, $name=null, $delete=false)

	sendFileAsString ($file, $name)

	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="\)

	getHtmlIncFiles ($type, $ln="\)

	beforeOut ()

	mediaDownload ($file, $forceDownload=false, $fileName=null, $delete=false)

	beforeInit ()

Protected Attributes
	$incFiles

	$blocks = array()

	$blocksJquery = array()

	$headers

	$beforeOut = array()

	$content

	$proxy = null

	$cfg

Detailed Description

XUL Response

Definition at line 10 of file xul.class.php.

Member Function Documentation

◆ __call()

__call	(	$func,
		$prm
	)

inherited

Here to avoid wrong call to the response object

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

◆ __toString()

__toString ( )

inherited

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

◆ add()

add ( array $prm )

inherited

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 233 of file html.class.php.

◆ addBeforeOut()

addBeforeOut ( $callback )

inherited

Add a callback before the out

Parameters

callback $callback

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

◆ addCss()

addCss ( $prm )

inherited

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 366 of file html.class.php.

◆ addHeader()

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()

addJs ( $prm )

inherited

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 347 of file html.class.php.

◆ addTitleAfter()

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

inherited

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

Parameters

string	$title
string	$sep

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

◆ addTitleBefore()

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

inherited

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

Parameters

string	$title
string	$sep

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

◆ afterInit()

afterInit ( )

protected

Definition at line 12 of file xul.class.php.

◆ beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

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

◆ beforeOut()

beforeOut ( )

protectedinherited

Execute the before out callbacks

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

◆ block()

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

inherited

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 381 of file html.class.php.

◆ blockCss()

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

inherited

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 425 of file html.class.php.

◆ blockjQuery()

blockjQuery	(	$block,
		$addjQuery = `true`
	)

inherited

Add a jQuery block

Parameters

string	$block	The javascript block
bool	$addjQuery	Indicate if jQuery should be automatically added

See also: blockJs

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

◆ blockJs()

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

inherited

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 400 of file html.class.php.

◆ canGlobalCache()

canGlobalCache ( )

inherited

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

◆ clearHeaders()

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 ( $comment )

inherited

Return the content commented regarding the request type

Parameters

string $comment

Returns: string

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

◆ error()

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 509 of file http.class.php.

◆ getAjaxLayout()

getAjaxLayout ( )

inherited

Get the ajax layout will be used

Returns: string

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

◆ getAttr()

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()

getCfg ( )

inherited

Get the configuration object

Returns: config

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

◆ getCompress()

getCompress ( )

inherited

Check if the compress mode is activate

Returns: bool

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

◆ getContent()

getContent ( )

inherited

Get the response content

Returns: mixed

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

◆ getDepend()

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

inherited

Get the dependancies for a file

Parameters

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

Returns: array

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

◆ getHeader()

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()

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

inherited

Get the HTML blocks

Parameters

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

Returns: string

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

◆ getHtmlElt()

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

inherited

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 438 of file html.class.php.

◆ getHtmlIncFiles()

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

protectedinherited

Get the HTML included files

Parameters

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

Returns: string

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

◆ getHtmlMeta()

getHtmlMeta ( $ln = "\n" )

protectedinherited

Get the HTML Meta

Parameters

string $ln New line character

Returns: strings

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

◆ getIncFiles()

getIncFiles ( )

inherited

Get the included files

Returns: array

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

◆ getIncludeTagFile()

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

inherited

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 557 of file html.class.php.

◆ getLayout()

getLayout ( )

inherited

Get the layout will be used

Returns: string

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

◆ getLink()

getLink ( $rel )

inherited

Get a link content

Parameters

string $rel Rel name

Returns: array|null

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

◆ getMeta()

getMeta ( $name )

inherited

Get a meta content

Parameters

string $name Meta name

Returns: string|null

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

◆ getMetaProperty()

getMetaProperty ( $name )

inherited

Get a meta property content

Parameters

string $name Meta name

Returns: string|null

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

◆ getProxy()

getProxy ( )

inherited

Get the response proxy (used in the templates)

Returns: response_proxy

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

◆ getStatus()

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()

getTitle ( )

inherited

Get the title

Returns: string|null

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

◆ getUrlFile()

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

inherited

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 571 of file html.class.php.

◆ getVarsForGlobalCache()

getVarsForGlobalCache ( )

inherited

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

◆ hasHeader()

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()

initBlocks ( $type )

protectedinherited

Initialize the blocks array for the requested type

Parameters

string $type

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

◆ initIncFiles()

initIncFiles ( $addDefaults = true )

inherited

Init incFiles variables

Parameters

bool $addDefaults Indicate if the default should be added

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

◆ mediaDownload()

mediaDownload	(	$file,
		$forceDownload = `false`,
		$fileName = `null`,
		$delete = `false`
	)

protectedinherited

Send a media to download, using HTTP range or not, is possible

Parameters

string	$file	File Path
bool	$forceDownload	True if the media should be forced to download
string	$fileName	Filename to send to the browser. If null, basename will be used
bool	$delete	Indicate if the file should be deleted after download

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

◆ neverExpire()

neverExpire ( )

inherited

Make the response to expire in 32 days

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

◆ redirect()

redirect	(	$url,
		$status = `301`
	)

inherited

Redirect the user with a header content

Parameters

string	$url
int	$status

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

◆ send() [1/2]

send ( )

abstractinherited

Send The response

◆ send() [2/2]

send ( $headerOnly = false )

inherited

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

◆ sendFile()

sendFile	(	$file,
		$name = `null`,
		$delete = `false`
	)

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
bool	$delete	Indicate if the file should be deleted after download

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

◆ sendFileAsString()

sendFileAsString	(	$file,
		$name
	)

inherited

Send a file for download using a string

Parameters

string	$file	File contents
string	$name	File name.

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

◆ sendHeaders()

sendHeaders ( )

inherited

Send HTTP headers and cookies.

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

◆ sendText()

sendText ( $text )

inherited

Send a text response (exit the programm)

Parameters

string $text

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

◆ setAjaxlayout()

setAjaxlayout ( $ajaxLayout )

inherited

Set a new ajax layout to use

Parameters

string $ajaxLayout

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

◆ setAttr()

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()

setCompress ( $compress )

inherited

Activate or desactivate the compress mode

Parameters

bool $compress

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

◆ setContent()

setContent ( $content )

inherited

set the response content

Parameters

mixed $content

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

◆ setContentType()

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()

setHtmlEltIntern ( $content )

protectedinherited

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

Parameters

string $content

Returns: string

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

◆ setlayout()

setlayout ( $layout )

inherited

Set a new layout to use

Parameters

string $layout

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

◆ setLink()

setLink	(		$rel,
		array	$attributes
	)

inherited

Set a link content

Parameters

string	$rel	Rel name
array	$attributes	Link attributes

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

◆ setMeta()

setMeta	(	$name,
		$value
	)

inherited

Set a meta content

Parameters

string	$name	Meta name
string	$value	Meta content

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

◆ setMetaAfter()

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

inherited

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 182 of file html.class.php.

◆ setMetaBefore()

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

inherited

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 169 of file html.class.php.

◆ setMetaProperty()

setMetaProperty	(	$name,
		$value
	)

inherited

Set a meta property content

Parameters

string	$name	Meta name
string	$value	Meta content

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

◆ setMetaPropertyAfter()

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

inherited

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

Parameters

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

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

◆ setMetaPropertyBefore()

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

inherited

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

Parameters

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

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

◆ setStatus()

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()

setTitle ( $title )

inherited

Set the title

Parameters

string $title

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

◆ setTitleInDes()

setTitleInDes ( $titleInDes )

inherited

Set the titleInDes setting

Parameters

false | string $titleInDes The string to use or false to deactivate

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

◆ setVarsFromGlobalCache()

setVarsFromGlobalCache ( $vars )

inherited

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

◆ showFile()

showFile ( $file )

inherited

Show a file to the client

Parameters

string $file File Path

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

Field Documentation

◆ $beforeOut

$beforeOut = array()

protectedinherited

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

◆ $blocks

$blocks = array()

protectedinherited

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

◆ $blocksJquery

$blocksJquery = array()

protectedinherited

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

◆ $cfg

$cfg

protectedinherited

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

◆ $content

$content

protectedinherited

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

◆ $headers

$headers

protectedinherited

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

◆ $incFiles

$incFiles

protectedinherited

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

◆ $proxy

$proxy = null

protectedinherited

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

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

xul.class.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ __toString()

◆ add()

◆ addBeforeOut()

◆ addCss()

◆ addHeader()

◆ addJs()

◆ addTitleAfter()

◆ addTitleBefore()

◆ afterInit()

◆ beforeInit()

◆ beforeOut()

◆ block()

◆ blockCss()

◆ blockjQuery()

◆ blockJs()

◆ canGlobalCache()

◆ clearHeaders()

◆ comment()

◆ error()

◆ getAjaxLayout()

◆ getAttr()

◆ getCfg()

◆ getCompress()

◆ getContent()

◆ getDepend()

◆ getHeader()

◆ getHtmlBlocks()

◆ getHtmlElt()

◆ getHtmlIncFiles()

◆ getHtmlMeta()

◆ getIncFiles()

◆ getIncludeTagFile()

◆ getLayout()

◆ getLink()

◆ getMeta()

◆ getMetaProperty()

◆ getProxy()

◆ getStatus()

◆ getTitle()

◆ getUrlFile()

◆ getVarsForGlobalCache()

◆ hasHeader()

◆ initBlocks()

◆ initIncFiles()

◆ mediaDownload()

◆ neverExpire()

◆ redirect()

◆ send() [1/2]

◆ send() [2/2]

◆ sendFile()

◆ sendFileAsString()

◆ sendHeaders()

◆ sendText()

◆ setAjaxlayout()

◆ setAttr()

◆ setCompress()

◆ setContent()

◆ setContentType()

◆ setHtmlEltIntern()

◆ setlayout()

◆ setLink()

◆ setMeta()

◆ setMetaAfter()

◆ setMetaBefore()

◆ setMetaProperty()

◆ setMetaPropertyAfter()

◆ setMetaPropertyBefore()

◆ setStatus()

◆ setTitle()

◆ setTitleInDes()

◆ setVarsFromGlobalCache()

◆ showFile()

Field Documentation

◆ $beforeOut