Actions

API17

Difference between revisions of "JApplication::enqueueMessage"

From Joomla! Documentation

(Layout updates)
(Examples: added frontent example)
(2 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JApplication::enqueueMessage|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JApplication::enqueueMessage|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JApplication::enqueueMessage ($msg, $type= 'message')
+
public function enqueueMessage (
 +
        $msg
 +
        $type= 'message'
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' void
void
+
* '''Defined''' on line 390 of libraries/joomla/application/application.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/application/application.php (line 390)
+
* see source code in [[jplatform:application/application.php#cl-390|BitBucket]]
+
===Referenced by===
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JApplication::enqueueMessage source code''' on [[jplatform:application/application.php#cl-382|BitBucket]]
 +
* {{JVer|11.1}} Class [[JApplication/11.1|JApplication]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
 +
* [[JApplication::enqueueMessage|Other versions of JApplication::enqueueMessage]]
 +
{{SeeAlso:JApplication::enqueueMessage}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JApplication::enqueueMessage|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JApplication::enqueueMessage|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JApplication/11.1|JApplication]]
 
* [[JApplication::enqueueMessage|Other versions of this method]]
 
{{SeeAlso:JApplication::enqueueMessage}}
 
 
===Examples===
 
===Examples===
 +
 +
To enqueue a message (in a module) for a administration/backend component:
 +
<source lang="php">
 +
$this->_mainframe->enqueueMessage('YOUR MESSAGE GOES HERE', 'message');
 +
</source>
 +
 +
To enqueue a message (in a module) for a website/frontent component:
 +
<source lang="php">
 +
JFactory::getApplication()->enqueueMessage('YOUR MESSAGE GOES HERE', 'message');
 +
</source>
 +
 +
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 53: Line 64:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JApplication]][[Category:JApplication::enqueueMessage]]</noinclude>
 
<noinclude>[[Category:JApplication]][[Category:JApplication::enqueueMessage]]</noinclude>

Revision as of 01:59, 23 June 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JApplication::enqueueMessage

Description

Enqueue a system message.

Description:JApplication::enqueueMessage [Edit Descripton]

public function enqueueMessage (
        $msg
        $type= 'message'
)
Parameter Type Default Description
$msg string The message to enqueue.
$type string 'message' The message type.
  • Returns void
  • Defined on line 390 of libraries/joomla/application/application.php
  • Since Joomla 11.1

See also

SeeAlso:JApplication::enqueueMessage [Edit See Also]

Examples

To enqueue a message (in a module) for a administration/backend component:

$this->_mainframe->enqueueMessage('YOUR MESSAGE GOES HERE', 'message');

To enqueue a message (in a module) for a website/frontent component:

JFactory::getApplication()->enqueueMessage('YOUR MESSAGE GOES HERE', 'message');

User contributed notes

<CodeExamplesForm />