Actions

API17

Difference between revisions of "JButtonHelp:: getCommand"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JButtonHelp::_getCommand|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JButtonHelp::_getCommand|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
protected JButtonHelp->_getCommand ($ref, $com, $override, $component)
+
protected function _getCommand (
 +
        $ref
 +
        $com
 +
        $override
 +
        $component
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 42: Line 44:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' string JavaScript command string
string JavaScript command string
+
* '''Defined''' on line 76 of libraries/joomla/html/toolbar/button/help.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/html/toolbar/button/help.php
+
===Referenced by===
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JButtonHelp::_getCommand source code''' on [[jplatform:html/toolbar/button/help.php#cl-68|BitBucket]]
 +
* {{JVer|11.1}} Class [[JButtonHelp/11.1|JButtonHelp]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Html/11.1|Html]]
 +
* [[JButtonHelp::_getCommand|Other versions of JButtonHelp::_getCommand]]
 +
{{SeeAlso:JButtonHelp::_getCommand}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JButtonHelp::_getCommand|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JButtonHelp::_getCommand|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JButtonHelp/11.1|JButtonHelp]]
+
===User contributed notes===
* [[JButtonHelp::_getCommand|Other versions of this method]]
+
{{SeeAlso:JButtonHelp::_getCommand}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 62: Line 64:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JButtonHelp]][[Category:JButtonHelp::_getCommand]]</noinclude>
 
<noinclude>[[Category:JButtonHelp]][[Category:JButtonHelp::_getCommand]]</noinclude>

Revision as of 20:13, 27 April 2011

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 JButtonHelp::_getCommand

Description

Get the JavaScript command for the button.

Description:JButtonHelp:: getCommand [Edit Descripton]

protected function _getCommand (
        $ref
        $com
        $override
        $component
)
Parameter Type Default Description
$ref string The name of the help screen (its key reference).
$com boolean Use the help file in the component directory.
$override string Use this URL instead of any other.
$component string Name of component to get Help (null for current component)
  • Returns string JavaScript command string
  • Defined on line 76 of libraries/joomla/html/toolbar/button/help.php
  • Since Joomla 11.1

See also

SeeAlso:JButtonHelp:: getCommand [Edit See Also]

User contributed notes

<CodeExamplesForm />