Jelix 1.8.11-rc.1

jResponseFormJQJson extends jResponse
in package

Response for jForms forms submitted with XHR (ajax).

It produces the JSON content of the response, expected by the jFormsJQ javascript object.

Tags

Table of Contents

$forcedHttpVersion  : bool
$httpVersion  : string
$_httpHeaders  : array<string|int, mixed>
$_httpHeadersSent  : bool
$_httpStatusCode  : string
$_httpStatusMsg  : string
$_outputOnlyHeaders  : bool
$_type  : string
$customData  : mixed
$errorLocationUrl  : mixed
$errorMessage  : mixed
$form  : jFormsBase
$locationUrl  : mixed
__construct()  : mixed
constructor.
addHttpHeader()  : mixed
add an http header to the response.
changeLocation()  : void
Set the url of the page that the browser will load (in Javascript) after receiving the http response, in case of there is no errors into the form.
cleanCacheHeaders()  : mixed
Clean the differents caches headers.
clearHttpHeaders()  : mixed
delete all http headers.
getFormatType()  : string
return the format type name (eg the family type name).
getHttpHeaders()  : mixed
getType()  : string
return the response type name.
isValidCache()  : bool
Use the HTTP headers Last-Modified to see if the resource in client cache is fresh.
output()  : mixed
outputErrors()  : mixed
Send a response with a generic error message.
setCustomData()  : void
Arbitrary data that will be sent
setError()  : mixed
The response will be an error.
setExpires()  : mixed
Set an expires header to the page/ressource.
setForm()  : void
Set the form for the response.
setHttpStatus()  : mixed
set the http status code for the http header.
setLifetime()  : mixed
Set a life time for the page/ressource.
_checkRequestType()  : mixed
check if the request is of type GET or HEAD.
_normalizeDate()  : string
Normalize a date into GMT format.
sendHttpHeaders()  : mixed
send http headers.

Properties

$forcedHttpVersion

public bool $forcedHttpVersion = \false

indicate to use the version from $httpVersion

Tags

$httpVersion

public string $httpVersion = '1.1'

the HTTP version to use for the response

Tags

$_httpHeaders

protected array<string|int, mixed> $_httpHeaders = array()

list of http headers that will be send to the client

Tags

$_httpHeadersSent

protected bool $_httpHeadersSent = \false

indicates if http headers have already been sent to the client

Tags

$_httpStatusCode

protected string $_httpStatusCode = '200'

the http status code to send

Tags

$_httpStatusMsg

protected string $_httpStatusMsg = 'OK'

the http status message to send

Tags

$_outputOnlyHeaders

protected bool $_outputOnlyHeaders = \false

Should we output only the headers or the entire response

Tags

Methods

__construct()

constructor.

public __construct() : mixed
Tags
Return values
mixed

addHttpHeader()

add an http header to the response.

public addHttpHeader(string $htype, string $hcontent[, int $overwrite = true ]) : mixed

will be send during the output of the response.

Parameters
$htype : string

the header type ("Content-Type", "Date-modified"...)

$hcontent : string

value of the header type

$overwrite : int = true

false or 0 if the value should be set only if it doesn't still exist -1 to add the header with the existing values true or 1 to replace the existing header

Tags
Return values
mixed

changeLocation()

Set the url of the page that the browser will load (in Javascript) after receiving the http response, in case of there is no errors into the form.

public changeLocation(string $url) : void
Parameters
$url : string
Tags
Return values
void

cleanCacheHeaders()

Clean the differents caches headers.

public cleanCacheHeaders() : mixed
Tags
Return values
mixed

clearHttpHeaders()

delete all http headers.

public clearHttpHeaders() : mixed
Tags
Return values
mixed

getFormatType()

return the format type name (eg the family type name).

public getFormatType() : string
Tags
Return values
string

the name

getHttpHeaders()

public getHttpHeaders() : mixed
Tags
Return values
mixed

getType()

return the response type name.

public final getType() : string
Tags
Return values
string

the name

isValidCache()

Use the HTTP headers Last-Modified to see if the resource in client cache is fresh.

public isValidCache([mixed $dateLastModified = null ][, null|mixed $etag = null ][, bool $cleanCacheHeader = true ]) : bool
Parameters
$dateLastModified : mixed = null

Can be a jDateTime object, a DateTime object or a string understandable by strtotime

$etag : null|mixed = null
$cleanCacheHeader : bool = true

True for clean/delete other cache headers. Default : true.

Tags
Return values
bool

True if the client resource version is fresh, false otherwise

outputErrors()

Send a response with a generic error message.

public outputErrors() : mixed
Tags
Return values
mixed

setCustomData()

Arbitrary data that will be sent

public setCustomData( $data) : void
Parameters
$data :
Tags
Return values
void

setError()

The response will be an error.

public setError([string $message = '' ][, string $locationUrl = '' ]) : mixed
Parameters
$message : string = ''

the error message to be displayed

$locationUrl : string = ''

the url to load into the browser. Will override the url given to changeLocation, if any.

Tags
Return values
mixed

setExpires()

Set an expires header to the page/ressource.

public setExpires(mixed $date[, mixed $cleanCacheHeader = true ]) : mixed
Parameters
$date : mixed
$cleanCacheHeader : mixed = true
Tags
see
jResponse::_normalizeDate()
Return values
mixed

setForm()

Set the form for the response.

public setForm(jFormsBase $form) : void

Its status and content will help to generate the JSON content for the HTTP response.

Parameters
$form : jFormsBase
Tags
Return values
void

setHttpStatus()

set the http status code for the http header.

public setHttpStatus(string $code, string $msg) : mixed
Parameters
$code : string

the status code (200, 404...)

$msg : string

the message following the status code ("OK", "Not Found"..)

Tags
Return values
mixed

setLifetime()

Set a life time for the page/ressource.

public setLifetime(int $time[, bool $sharedCache = false ][, mixed $cleanCacheHeader = true ]) : mixed
Parameters
$time : int

Time during which the page will be cached. Express in seconds.

$sharedCache : bool = false

True if the lifetime concern a public/shared cache. Default : false.

$cleanCacheHeader : mixed = true
Tags
Return values
mixed

_checkRequestType()

check if the request is of type GET or HEAD.

protected _checkRequestType() : mixed
Tags
Return values
mixed

_normalizeDate()

Normalize a date into GMT format.

protected _normalizeDate(mixed $date) : string
Parameters
$date : mixed

Can be a jDateTime object, a DateTime object or a string understandable by strtotime

Tags
Return values
string

a date in GMT format

sendHttpHeaders()

send http headers.

protected sendHttpHeaders() : mixed
Tags
Return values
mixed

Search results