API17

Difference between revisions of "JController::setMessage"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JController::setMessage|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JController::setMessage|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JController::setMessage ($text, $type= 'message')
+
public function setMessage (
 +
        $text
 +
        $type= 'message'
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' string Previous message
string Previous message
+
* '''Defined''' on line 934 of libraries/joomla/application/component/controller.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/application/component/controller.php (line 934)
 
* see source code in [[jplatform:application/component/controller.php#cl-934|BitBucket]]
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JController::setMessage source code''' on [[jplatform:application/component/controller.php#cl-926|BitBucket]]
 +
* {{JVer|11.1}} Class [[JController/11.1|JController]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
 +
* [[JController::setMessage|Other versions of JController::setMessage]]
 +
{{SeeAlso:JController::setMessage}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JController::setMessage|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JController::setMessage|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JController/11.1|JController]]
+
===User contributed notes===
* [[JController::setMessage|Other versions of this method]]
 
{{SeeAlso:JController::setMessage}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 53: Line 52:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JController]][[Category:JController::setMessage]]</noinclude>
 
<noinclude>[[Category:JController]][[Category:JController::setMessage]]</noinclude>

Revision as of 20:22, 27 April 2011

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JController::setMessage[edit]

Description[edit]

Sets the internal message that is passed with a redirect.

Template:Description:JController::setMessage [Edit Descripton]

public function setMessage (
        $text
        $type= 'message'
)
Parameter Type Default Description
$text string Message to display on redirect.
$type string 'message' Message type (since 11.1). Optional, defaults to 'message'.
  • Returns string Previous message
  • Defined on line 934 of libraries/joomla/application/component/controller.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JController::setMessage [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />