Zymba Documentation

HTTP

Text

object @HTTP() {
	canSendHeaders(): bool {}
	clearHeaders() {}
	countRequestHeaders(): int {}
	countResponseHeaders(): int {}
	getAuthenticationPassword(): string {}
	getAuthenticationUser(): string {}
	getDocumentRoot(): string {}
	getLocalAddress(): string {}
	getLocalHost(): string {}
	getLocalPort(): int {}
	getRemoteAddress(): string {}
	getRemoteHost(): string {}
	getRemotePort(): int {}
	getRequestBody(): string {}
	getRequestCookie(string $name): string {}
	getRequestFileUpload(string $name): object {}
	getRequestFormVariable(string $name): string {}
	getRequestHeader(string $name): string {}
	getRequestMethod(): string {}
	getRequestQuery(): string {}
	getRequestQueryVariable(string $name): string {}
	getRequestType(): string {}
	getRequestURL(): string {}
	getRequestVariable(string $name): string {}
	getResponseHeader(string $name): string {}
	getStatusCode(): int {}
	isConnectionAborted(): bool {}
	isConnectionSecure(): bool {}
	listRequestCookies(): object {}
	listRequestFileUploads(): object {}
	listRequestFormVariables(): object {}
	listRequestHeaderNames(): object {}
	listRequestHeaders(): object {}
	listRequestQueryVariables(): object {}
	listRequestVariables(): object {}
	listResponseHeaderNames(): object {}
	listResponseHeaders(): object {}
	removeHeader(string $name) {}
	removeHeaders(object $names) {}
	request(string $url, string $method, string $body, object $headers, int $timeout, bool $validate): object {}
	requestBody(string $url, string $method, string $body, object $headers, int $timeout, bool $validate): string {}
	setBasicAuthentication(string $realm) {}
	setCacheExpires(int $seconds) {}
	setCookie(string $name, string $value, int $expires, string $path, string $domain, bool $secure, bool $httponly) {}
	setHeader(string $name, string $value) {}
	setHeaders(object $headers, string $prefix) {}
	setStatusCode(int $code) {}
}

Static HTTP related functions.

Functions

Determines whether HTTP response headers can be sent.

CODE

@HTTP.canSendHeaders(): bool

Returns

Type	Value
bool

Removes all previously set HTTP response headers.

CODE

@HTTP.clearHeaders(): void

Counts the total number of HTTP request headers.

CODE

@HTTP.countRequestHeaders(): int

Returns

Type	Value
int

Counts the total number of HTTP response headers.

CODE

@HTTP.countResponseHeaders(): int

Returns

Type	Value
int

CODE

@HTTP.getAuthenticationPassword(): string

Returns

Type	Value
string

CODE

@HTTP.getAuthenticationUser(): string

Returns

Type	Value
string

Gets the path of the local server's document root directory.

CODE

@HTTP.getDocumentRoot(): string

Returns

Type	Value
string

Gets the IP address of the local server.

CODE

@HTTP.getLocalAddress(): string

Returns

Type	Value
string

Gets the host name of the local server.

CODE

@HTTP.getLocalHost(): string

Returns

Type	Value
string

Gets the port number of the local server.

CODE

@HTTP.getLocalPort(): int

Returns

Type	Value
int

Gets the IP address of the remote client.

CODE

@HTTP.getRemoteAddress(): string

Returns

Type	Value
string

Gets the host name of the remote client.

CODE

@HTTP.getRemoteHost(): string

Returns

Type	Value
string

Gets the port number of the remote client.

CODE

@HTTP.getRemotePort(): int

Returns

Type	Value
int

Gets the HTTP request body in raw format.

CODE

@HTTP.getRequestBody(): string

Returns

Type	Value
string

Gets the value of a HTTP request cookie.

CODE

@HTTP.getRequestCookie(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
null

Gets the details of a HTTP request file upload.

CODE

@HTTP.getRequestFileUpload(string $name): object

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
object	["name": ..., "type": ..., "tmp_name": ..., "error": ..., "size": ...]
null

Gets the value of a HTTP request variable submitted via the POST method with content type "application/x-www-form-urlencoded" or "multipart/form-data" according to RFC 2388.

CODE

@HTTP.getRequestFormVariable(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
null

Gets the value of a HTTP request header.

CODE

@HTTP.getRequestHeader(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
null

Gets the HTTP request method.

CODE

@HTTP.getRequestMethod(): string

Returns

Type	Value
string

Gets the query component of the HTTP request URL.

CODE

@HTTP.getRequestQuery(): string

Returns

Type	Value
string

Gets the value of a HTTP request variable submitted via the URL query component.

CODE

@HTTP.getRequestQueryVariable(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
null

Gets the content type of the HTTP request.

CODE

@HTTP.getRequestType(): string

Returns

Type	Value
string

Gets the complete HTTP request URL.

CODE

@HTTP.getRequestURL(): string

Returns

Type	Value
string

Gets the value of a HTTP request variable.

CODE

@HTTP.getRequestVariable(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
null

Gets the value of a HTTP response header.

CODE

@HTTP.getResponseHeader(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
null

Gets the current HTTP response status code.

CODE

@HTTP.getStatusCode(): int

Returns

Type	Value
int

Determines whether the current connection is aborted, meaning the client has disconnected.

CODE

@HTTP.isConnectionAborted(): bool

Returns

Type	Value
bool

Determines whether the current connection is secure, meaning over HTTPS.

CODE

@HTTP.isConnectionSecure(): bool

Returns

Type	Value
bool

Lists all HTTP request cookies.

CODE

@HTTP.listRequestCookies(): object

Returns

Type	Value
object	[name: value, ...]

Lists the details of all HTTP request file uploads submitted via the POST method with content type "multipart/form-data" according to RFC 1867.

CODE

@HTTP.listRequestFileUploads(): object

Returns

Type	Value
object	[name: ["name": ..., "type": ..., "tmp_name": ..., "error": ..., "size": ...], ...]

Lists all HTTP request variables submitted via the POST method with content type "application/x-www-form-urlencoded" or "multipart/form-data" according to RFC 2388.

CODE

@HTTP.listRequestFormVariables(): object

Returns

Type	Value
object	[name: value, ...]

Lists all HTTP request header names.

CODE

@HTTP.listRequestHeaderNames(): object

Returns

Type	Value
object	[name, ...]

Lists all HTTP request headers.

CODE

@HTTP.listRequestHeaders(): object

Returns

Type	Value
object	[name: value, ...]

Lists all HTTP request variables submitted via the URL query component.

CODE

@HTTP.listRequestQueryVariables(): object

Returns

Type	Value
object	[name: value, ...]

Lists all HTTP request variables.

CODE

@HTTP.listRequestVariables(): object

Returns

Type	Value
object	[name: value, ...]

Lists all HTTP response header names.

CODE

@HTTP.listResponseHeaderNames(): object

Returns

Type	Value
object	[name, ...]

Lists all HTTP response headers.

CODE

@HTTP.listResponseHeaders(): object

Returns

Type	Value
object	[name: value, ...]

Removes a HTTP response header.

CODE

@HTTP.removeHeader(string $name): void

Parameters

Name	Type	Value	Default
name	string		""

Removes multiple HTTP response headers.

CODE

@HTTP.removeHeaders(object $names): void

Parameters

Name	Type	Value	Default
names	object	[name, ...]	[]

CODE

@HTTP.request(string $url, string $method, string $body, object $headers, int $timeout, bool $validate): object

Parameters

Name	Type	Value	Default
url	string		""
method	string		"GET"
body	string		""
headers	object	[name: value, ...]	[]
timeout	int		60
validate	bool		true

Returns

Type	Value
object	["url": ..., "status": ..., "type": ..., "time": ..., "header": ..., "body": ...]

CODE

@HTTP.requestBody(string $url, string $method, string $body, object $headers, int $timeout, bool $validate): string

Parameters

Name	Type	Value	Default
url	string		""
method	string		"GET"
body	string		""
headers	object	[name: value, ...]	[]
timeout	int		60
validate	bool		true

Returns

Type	Value
string

CODE

@HTTP.setBasicAuthentication(string $realm): void

Parameters

Name	Type	Value	Default
realm	string		""

CODE

@HTTP.setCacheExpires(int $seconds): void

Parameters

Name	Type	Value	Default
seconds	int		86400

CODE

@HTTP.setCookie(string $name, string $value, int $expires, string $path, string $domain, bool $secure, bool $httponly): void

Parameters

Name	Type	Value	Default
name	string		""
value	string		""
expires	int		0
path	string		""
domain	string		""
secure	bool		false
httponly	bool		false

Sets a HTTP response header.

CODE

@HTTP.setHeader(string $name, string $value): void

Parameters

Name	Type	Value	Default
name	string		""
value	string		""

Sets multiple HTTP response headers by treating slot names as header names, expanded by a specific prefix, and slot values as non-referential header values.

CODE

@HTTP.setHeaders(object $headers, string $prefix): void

Parameters

Name	Type	Value	Default
headers	object	[name: value, ...]	[]
prefix	string		""

Sets the HTTP response status code.

CODE

@HTTP.setStatusCode(int $code): void

Parameters

Name	Type	Value	Default
code	int		200