API17:JResponse
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JResponse== | ||
| + | ===Description=== | ||
| + | {{Description:JResponse}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JResponse|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JResponse|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::allowCache/11.1|allowCache]] | |[[JResponse::allowCache/11.1|allowCache]] | ||
|Set/get cachable state for the response. | |Set/get cachable state for the response. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::appendBody/11.1|appendBody]] | |[[JResponse::appendBody/11.1|appendBody]] | ||
|Append content to the body content. | |Append content to the body content. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::clearHeaders/11.1|clearHeaders]] | |[[JResponse::clearHeaders/11.1|clearHeaders]] | ||
|Clear headers. | |Clear headers. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::getBody/11.1|getBody]] | |[[JResponse::getBody/11.1|getBody]] | ||
|Return the body content. | |Return the body content. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::getHeaders/11.1|getHeaders]] | |[[JResponse::getHeaders/11.1|getHeaders]] | ||
|Return array of headers. | |Return array of headers. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::prependBody/11.1|prependBody]] | |[[JResponse::prependBody/11.1|prependBody]] | ||
|Prepend content to the body content. | |Prepend content to the body content. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::sendHeaders/11.1|sendHeaders]] | |[[JResponse::sendHeaders/11.1|sendHeaders]] | ||
|Send all headers. | |Send all headers. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::setBody/11.1|setBody]] | |[[JResponse::setBody/11.1|setBody]] | ||
|Set body content. | |Set body content. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::setHeader/11.1|setHeader]] | |[[JResponse::setHeader/11.1|setHeader]] | ||
|Set a header. | |Set a header. | ||
|- | |- | ||
| + | |public static | ||
|[[JResponse::toString/11.1|toString]] | |[[JResponse::toString/11.1|toString]] | ||
|Sends all headers prior to returning the string. | |Sends all headers prior to returning the string. | ||
|- | |- | ||
| + | |protected static | ||
|[[JResponse::clientEncoding/11.1|clientEncoding]] | |[[JResponse::clientEncoding/11.1|clientEncoding]] | ||
|Check, whether client supports compressed data. | |Check, whether client supports compressed data. | ||
|- | |- | ||
| + | |protected static | ||
|[[JResponse::compress/11.1|compress]] | |[[JResponse::compress/11.1|compress]] | ||
|Compress the data. | |Compress the data. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/environment/response.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.environment.response' );</source> | <source lang="php">jimport( 'joomla.environment.response' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JResponse source code | + | * {{JVer|11.1}} '''JResponse source code''' on [[jplatform:environment/response.php|BitBucket]] |
| − | * [[JResponse|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Environment/11.1|Environment]] |
| + | * [[JResponse|Other versions of JResponse]] | ||
{{SeeAlso:JResponse}} | {{SeeAlso:JResponse}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JResponse|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JResponse|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 71: | Line 81: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JResponse]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JResponse]]</noinclude> | ||
Revision as of 18:08, 27 April 2011
JResponse
Description
Description:JResponse [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public static | allowCache | Set/get cachable state for the response. |
| public static | appendBody | Append content to the body content. |
| public static | clearHeaders | Clear headers. |
| public static | getBody | Return the body content. |
| public static | getHeaders | Return array of headers. |
| public static | prependBody | Prepend content to the body content. |
| public static | sendHeaders | Send all headers. |
| public static | setBody | Set body content. |
| public static | setHeader | Set a header. |
| public static | toString | Sends all headers prior to returning the string. |
| protected static | clientEncoding | Check, whether client supports compressed data. |
| protected static | compress | Compress the data. |
- Defined in libraries/joomla/environment/response.php
Importing
jimport( 'joomla.environment.response' );
See also
- JResponse source code on BitBucket
- Subpackage Environment
- Other versions of JResponse
SeeAlso:JResponse [Edit See Also]
User contributed notes
<CodeExamplesForm />
