| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Part of the Joomla Framework Application Package
| Copyright: | Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. |
| License: | GNU General Public License version 2 or later; see LICENSE |
| File Size: | 183 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WebApplicationInterface:: (15 methods):
getInput()
redirect()
allowCache()
setHeader()
getHeaders()
clearHeaders()
sendHeaders()
setBody()
prependBody()
appendBody()
getBody()
getResponse()
isValidHttpStatus()
setResponse()
isSslConnection()
Interface: WebApplicationInterface - X-Ref
Application sub-interface defining a web application class| getInput() X-Ref |
| Method to get the application input object. return: Input |
| redirect($url, $status = 303) X-Ref |
| Redirect to another URL. If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" or "303 See Other" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement. param: string $url The URL to redirect to. Can only be http/https URL param: integer|boolean $status The HTTP status code to be provided. 303 is assumed by default. return: void |
| allowCache($allow = null) X-Ref |
| Set/get cachable state for the response. If $allow is set, sets the cachable state of the response. Always returns the current state. param: boolean $allow True to allow browser caching. return: boolean |
| setHeader($name, $value, $replace = false) X-Ref |
| Method to set a response header. If the replace flag is set then all headers with the given name will be replaced by the new one. The headers are stored in an internal array to be sent when the site is sent to the browser. param: string $name The name of the header to set. param: string $value The value of the header to set. param: boolean $replace True to replace any headers with the same name. return: $this |
| getHeaders() X-Ref |
| Method to get the array of response headers to be sent when the response is sent to the client. return: array |
| clearHeaders() X-Ref |
| Method to clear any set response headers. return: $this |
| sendHeaders() X-Ref |
| Send the response headers. return: $this |
| setBody($content) X-Ref |
| Set body content. If body content already defined, this will replace it. param: string $content The content to set as the response body. return: $this |
| prependBody($content) X-Ref |
| Prepend content to the body content param: string $content The content to prepend to the response body. return: $this |
| appendBody($content) X-Ref |
| Append content to the body content param: string $content The content to append to the response body. return: $this |
| getBody() X-Ref |
| Return the body content return: mixed The response body as a string. |
| getResponse() X-Ref |
| Get the PSR-7 Response Object. return: ResponseInterface |
| isValidHttpStatus($code) X-Ref |
| Check if the value is a valid HTTP status code param: integer $code The potential status code return: boolean |
| setResponse(ResponseInterface $response) X-Ref |
| Set the PSR-7 Response Object. param: ResponseInterface $response The response object return: void |
| isSslConnection() X-Ref |
| Determine if we are using a secure (SSL) connection. return: boolean True if using SSL, false if not. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |