Joomla! Documentation - User contributions [en]

API17:Subpackages

2011-04-28T02:58:47Z

Doxiki2: Updated to r1448:247ba8d88526

{{Description:Subpackages}}

The following subpackages are available in this version:-
* [[Subpackage Access/11.1|Access]]
* [[Subpackage Application/11.1|Application]]
* [[Subpackage Base/11.1|Base]]
* [[Subpackage Cache/11.1|Cache]]
* [[Subpackage Client/11.1|Client]]
* [[Subpackage Database/11.1|Database]]
* [[Subpackage Document/11.1|Document]]
* [[Subpackage Environment/11.1|Environment]]
* [[Subpackage Error/11.1|Error]]
* [[Subpackage Event/11.1|Event]]
* [[Subpackage Filesystem/11.1|Filesystem]]
* [[Subpackage Filter/11.1|Filter]]
* [[Subpackage Form/11.1|Form]]
* [[Subpackage Html/11.1|Html]]
* [[Subpackage Installer/11.1|Installer]]
* [[Subpackage Language/11.1|Language]]
* [[Subpackage Log/11.1|Log]]
* [[Subpackage Mail/11.1|Mail]]
* [[Subpackage Plugin/11.1|Plugin]]
* [[Subpackage Registry/11.1|Registry]]
* [[Subpackage Session/11.1|Session]]
* [[Subpackage Updater/11.1|Updater]]
* [[Subpackage User/11.1|User]]
* [[Subpackage Utilities/11.1|Utilities]]
===See Also===
* [[Platform/11.1|Platform 11.1]]
* [[Framework|Framework]]
<noinclude>[[Category:Platform 11.1]][[Category:Subpackages 11.1]][[Category:Subpackages]]</noinclude>

API17:Subpackage Database

2011-04-28T02:57:52Z

Doxiki2: Updated to r1448:247ba8d88526

The following classes belong to this subpackage:-
* [[DatabaseException/11.1|DatabaseException]]
* [[JDatabase/11.1|JDatabase]]
* [[JDatabaseExporterMySQL/11.1|JDatabaseExporterMySQL]]
* [[JDatabaseExporterMySQLi/11.1|JDatabaseExporterMySQLi]]
* [[JDatabaseImporterMySQL/11.1|JDatabaseImporterMySQL]]
* [[JDatabaseImporterMySQLi/11.1|JDatabaseImporterMySQLi]]
* [[JDatabaseMySQL/11.1|JDatabaseMySQL]]
* [[JDatabaseMySQLi/11.1|JDatabaseMySQLi]]
* [[JDatabaseQuery/11.1|JDatabaseQuery]]
* [[JDatabaseQueryElement/11.1|JDatabaseQueryElement]]
* [[JDatabaseQueryElementMySQL/11.1|JDatabaseQueryElementMySQL]]
* [[JDatabaseQueryElementMySQLi/11.1|JDatabaseQueryElementMySQLi]]
* [[JDatabaseQueryElementSQLAzure/11.1|JDatabaseQueryElementSQLAzure]]
* [[JDatabaseQueryElementSQLSrv/11.1|JDatabaseQueryElementSQLSrv]]
* [[JDatabaseQueryMySQL/11.1|JDatabaseQueryMySQL]]
* [[JDatabaseQueryMySQLi/11.1|JDatabaseQueryMySQLi]]
* [[JDatabaseQuerySQLAzure/11.1|JDatabaseQuerySQLAzure]]
* [[JDatabaseQuerySQLSrv/11.1|JDatabaseQuerySQLSrv]]
* [[JDatabaseSQLAzure/11.1|JDatabaseSQLAzure]]
* [[JDatabaseSQLSrv/11.1|JDatabaseSQLSrv]]
* [[JTable/11.1|JTable]]
* [[JTableAsset/11.1|JTableAsset]]
* [[JTableCategory/11.1|JTableCategory]]
* [[JTableContent/11.1|JTableContent]]
* [[JTableExtension/11.1|JTableExtension]]
* [[JTableLanguage/11.1|JTableLanguage]]
* [[JTableMenu/11.1|JTableMenu]]
* [[JTableMenuType/11.1|JTableMenuType]]
* [[JTableModule/11.1|JTableModule]]
* [[JTableNested/11.1|JTableNested]]
* [[JTableSession/11.1|JTableSession]]
* [[JTableUpdate/11.1|JTableUpdate]]
* [[JTableUser/11.1|JTableUser]]
* [[JTableUsergroup/11.1|JTableUsergroup]]
* [[JTableViewlevel/11.1|JTableViewlevel]]
===See Also===
* [[Subpackage Database|Other versions]]
* [[Subpackages/11.1|Other subpackages]]
<noinclude>[[Category:Platform 11.1]][[Category:Subpackages 11.1]]</noinclude>

API17:Subpackage Application

2011-04-28T02:57:42Z

Doxiki2: Updated to r1448:247ba8d88526

API17:JXMLElement::name

2011-04-28T02:57:35Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JXMLElement::name==
===Description===
Get the name of the element.

{{Description:JXMLElement::name}}

<nowiki>[</nowiki>[[Description:JXMLElement::name|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function name ()
</source>
* '''Returns'''
* '''Defined''' on line 29 of libraries/joomla/utilities/xmlelement.php
===See also===
* {{JVer|11.1}} '''JXMLElement::name source code''' on [[jplatform:utilities/xmlelement.php#cl-21|BitBucket]]
* {{JVer|11.1}} Class [[JXMLElement/11.1|JXMLElement]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JXMLElement::name|Other versions of JXMLElement::name]]
{{SeeAlso:JXMLElement::name}}

<nowiki>[</nowiki>[[SeeAlso:JXMLElement::name|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JXMLElement::name
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JXMLElement]][[Category:JXMLElement::name]]</noinclude>

API17:JXMLElement::getAttribute

2011-04-28T02:57:31Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JXMLElement::getAttribute==
===Description===
Legacy method gets an elements attribute by name.

{{Description:JXMLElement::getAttribute}}

<nowiki>[</nowiki>[[Description:JXMLElement::getAttribute|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function getAttribute ($name)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$name
|string
|
|
|-
|}
* '''Returns''' string
* '''Defined''' on line 58 of libraries/joomla/utilities/xmlelement.php
===See also===
* {{JVer|11.1}} '''JXMLElement::getAttribute source code''' on [[jplatform:utilities/xmlelement.php#cl-50|BitBucket]]
* {{JVer|11.1}} Class [[JXMLElement/11.1|JXMLElement]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JXMLElement::getAttribute|Other versions of JXMLElement::getAttribute]]
{{SeeAlso:JXMLElement::getAttribute}}

<nowiki>[</nowiki>[[SeeAlso:JXMLElement::getAttribute|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JXMLElement::getAttribute
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JXMLElement]][[Category:JXMLElement::getAttribute]]</noinclude>

API17:JXMLElement::data

2011-04-28T02:57:29Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JXMLElement::data==
===Description===
Legacy method to get the element data.

{{Description:JXMLElement::data}}

<nowiki>[</nowiki>[[Description:JXMLElement::data|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function data ()
</source>
* '''Returns''' string
* '''Defined''' on line 45 of libraries/joomla/utilities/xmlelement.php
===See also===
* {{JVer|11.1}} '''JXMLElement::data source code''' on [[jplatform:utilities/xmlelement.php#cl-37|BitBucket]]
* {{JVer|11.1}} Class [[JXMLElement/11.1|JXMLElement]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JXMLElement::data|Other versions of JXMLElement::data]]
{{SeeAlso:JXMLElement::data}}

<nowiki>[</nowiki>[[SeeAlso:JXMLElement::data|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JXMLElement::data
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JXMLElement]][[Category:JXMLElement::data]]</noinclude>

API17:JXMLElement::asFormattedXML

2011-04-28T02:57:26Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JXMLElement::asFormattedXML==
===Description===
Return a well-formed XML string based on SimpleXML element.

{{Description:JXMLElement::asFormattedXML}}

<nowiki>[</nowiki>[[Description:JXMLElement::asFormattedXML|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function asFormattedXML (
$compressed=false
$indent="\t"
$level=0
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$compressed
|boolean
|false
|Should we use indentation and newlines ?
|-
|$indent
|integer
|"\t"
|Indentaion level.
|-
|$level
|
|0
|
|-
|}
* '''Returns''' string
* '''Defined''' on line 71 of libraries/joomla/utilities/xmlelement.php
===See also===
* {{JVer|11.1}} '''JXMLElement::asFormattedXML source code''' on [[jplatform:utilities/xmlelement.php#cl-63|BitBucket]]
* {{JVer|11.1}} Class [[JXMLElement/11.1|JXMLElement]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JXMLElement::asFormattedXML|Other versions of JXMLElement::asFormattedXML]]
{{SeeAlso:JXMLElement::asFormattedXML}}

<nowiki>[</nowiki>[[SeeAlso:JXMLElement::asFormattedXML|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JXMLElement::asFormattedXML
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JXMLElement]][[Category:JXMLElement::asFormattedXML]]</noinclude>

API17:JView::setModel

2011-04-28T02:57:23Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::setModel==
===Description===
Method to add a model to the view.

{{Description:JView::setModel}}

<nowiki>[</nowiki>[[Description:JView::setModel|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setModel (
&$model
$default=false
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|&$model
|
|
|
|-
|$default
|
|false
|
|-
|}
* '''Returns'''
* '''Defined''' on line 436 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::setModel source code''' on [[jplatform:application/component/view.php#cl-428|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::setModel|Other versions of JView::setModel]]
{{SeeAlso:JView::setModel}}

<nowiki>[</nowiki>[[SeeAlso:JView::setModel|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::setModel
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::setModel]]</noinclude>

API17:JView::setLayoutExt

2011-04-28T02:57:20Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::setLayoutExt==
===Description===
Allows a different extension for the layout files to be used.

{{Description:JView::setLayoutExt}}

<nowiki>[</nowiki>[[Description:JView::setLayoutExt|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setLayoutExt ($value)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$value
|string
|
|The extension
|-
|}
* '''Returns''' string Previous value
* '''Defined''' on line 480 of libraries/joomla/application/component/view.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JView::setLayoutExt source code''' on [[jplatform:application/component/view.php#cl-472|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::setLayoutExt|Other versions of JView::setLayoutExt]]
{{SeeAlso:JView::setLayoutExt}}

<nowiki>[</nowiki>[[SeeAlso:JView::setLayoutExt|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::setLayoutExt
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::setLayoutExt]]</noinclude>

API17:JView::setLayout

2011-04-28T02:57:16Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::setLayout==
===Description===
Sets the layout name to use.

{{Description:JView::setLayout}}

<nowiki>[</nowiki>[[Description:JView::setLayout|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setLayout ($layout)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$layout
|string
|
|The layout name or a string in format <template>:<layout file>="">
|-
|}
* '''Returns''' string Previous value
* '''Defined''' on line 455 of libraries/joomla/application/component/view.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JView::setLayout source code''' on [[jplatform:application/component/view.php#cl-447|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::setLayout|Other versions of JView::setLayout]]
{{SeeAlso:JView::setLayout}}

<nowiki>[</nowiki>[[SeeAlso:JView::setLayout|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::setLayout
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::setLayout]]</noinclude>

API17:JView::setEscape

2011-04-28T02:57:13Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::setEscape==
===Description===
Sets the _escape() callback.

{{Description:JView::setEscape}}

<nowiki>[</nowiki>[[Description:JView::setEscape|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setEscape ($spec)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$spec
|mixed
|
|The callback for _escape() to use.
|-
|}
* '''Returns'''
* '''Defined''' on line 494 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::setEscape source code''' on [[jplatform:application/component/view.php#cl-486|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::setEscape|Other versions of JView::setEscape]]
{{SeeAlso:JView::setEscape}}

<nowiki>[</nowiki>[[SeeAlso:JView::setEscape|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::setEscape
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::setEscape]]</noinclude>

API17:JView::loadTemplate

2011-04-28T02:57:10Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::loadTemplate==
===Description===
Load a template file -- first look in the templates folder for an override.

{{Description:JView::loadTemplate}}

<nowiki>[</nowiki>[[Description:JView::loadTemplate|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function loadTemplate ($tpl=null)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$tpl
|string
|null
|The name of the template source file ... automatically searches the template paths and compiles as needed.
|-
|}
* '''Returns''' string The output of the the template script.
* '''Defined''' on line 528 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::loadTemplate source code''' on [[jplatform:application/component/view.php#cl-520|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::loadTemplate|Other versions of JView::loadTemplate]]
{{SeeAlso:JView::loadTemplate}}

<nowiki>[</nowiki>[[SeeAlso:JView::loadTemplate|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::loadTemplate
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::loadTemplate]]</noinclude>

API17:JView::loadHelper

2011-04-28T02:57:08Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::loadHelper==
===Description===
Load a helper file.

{{Description:JView::loadHelper}}

<nowiki>[</nowiki>[[Description:JView::loadHelper|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function loadHelper ($hlp=null)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$hlp
|string
|null
|The name of the helper source file ... automatically searches the helper paths and compiles as needed.
|-
|}
* '''Returns''' boolean Returns true if the file was loaded
* '''Defined''' on line 604 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::loadHelper source code''' on [[jplatform:application/component/view.php#cl-596|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::loadHelper|Other versions of JView::loadHelper]]
{{SeeAlso:JView::loadHelper}}

<nowiki>[</nowiki>[[SeeAlso:JView::loadHelper|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::loadHelper
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::loadHelper]]</noinclude>

API17:JView::getName

2011-04-28T02:57:05Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::getName==
===Description===
Method to get the view name.

{{Description:JView::getName}}

<nowiki>[</nowiki>[[Description:JView::getName|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function getName ()
</source>
* '''Returns'''
* '''Defined''' on line 405 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::getName source code''' on [[jplatform:application/component/view.php#cl-397|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::getName|Other versions of JView::getName]]
{{SeeAlso:JView::getName}}

<nowiki>[</nowiki>[[SeeAlso:JView::getName|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::getName
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::getName]]</noinclude>

API17:JView::getModel

2011-04-28T02:57:02Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::getModel==
===Description===
Method to get the model object.

{{Description:JView::getModel}}

<nowiki>[</nowiki>[[Description:JView::getModel|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function getModel ($name=null)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$name
|string
|null
|The name of the model (optional)
|-
|}
* '''Returns''' mixed object
* '''Defined''' on line 368 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::getModel source code''' on [[jplatform:application/component/view.php#cl-360|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::getModel|Other versions of JView::getModel]]
{{SeeAlso:JView::getModel}}

<nowiki>[</nowiki>[[SeeAlso:JView::getModel|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::getModel
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::getModel]]</noinclude>

API17:JView::getLayoutTemplate

2011-04-28T02:56:59Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::getLayoutTemplate==
===Description===
Get the layout template.

{{Description:JView::getLayoutTemplate}}

<nowiki>[</nowiki>[[Description:JView::getLayoutTemplate|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function getLayoutTemplate ()
</source>
* '''Returns''' string The layout template name
* '''Defined''' on line 391 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::getLayoutTemplate source code''' on [[jplatform:application/component/view.php#cl-383|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::getLayoutTemplate|Other versions of JView::getLayoutTemplate]]
{{SeeAlso:JView::getLayoutTemplate}}

<nowiki>[</nowiki>[[SeeAlso:JView::getLayoutTemplate|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::getLayoutTemplate
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::getLayoutTemplate]]</noinclude>

API17:JView::getLayout

2011-04-28T02:56:55Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::getLayout==
===Description===
Get the layout.

{{Description:JView::getLayout}}

<nowiki>[</nowiki>[[Description:JView::getLayout|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function getLayout ()
</source>
* '''Returns''' string The layout name
* '''Defined''' on line 381 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::getLayout source code''' on [[jplatform:application/component/view.php#cl-373|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::getLayout|Other versions of JView::getLayout]]
{{SeeAlso:JView::getLayout}}

<nowiki>[</nowiki>[[SeeAlso:JView::getLayout|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::getLayout
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::getLayout]]</noinclude>

API17:JView::get

2011-04-28T02:56:51Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::get==
===Description===
Method to get data from a registered model or a property of the view.

{{Description:JView::get}}

<nowiki>[</nowiki>[[Description:JView::get|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function get (
$property
$default=null
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$property
|string
|
|The name of the method to call on the model or the property to get
|-
|$default
|string
|null
|The name of the model to reference or the default value [optional]
|-
|}
* '''Returns''' mixed The return value of the method
* '''Defined''' on line 330 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::get source code''' on [[jplatform:application/component/view.php#cl-322|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::get|Other versions of JView::get]]
{{SeeAlso:JView::get}}

<nowiki>[</nowiki>[[SeeAlso:JView::get|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::get
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::get]]</noinclude>

API17:JView::escape

2011-04-28T02:56:48Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::escape==
===Description===
Escapes a value for output in a view script.

{{Description:JView::escape}}

<nowiki>[</nowiki>[[Description:JView::escape|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function escape ($var)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$var
|
|
|
|-
|}
* '''Returns'''
* '''Defined''' on line 314 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::escape source code''' on [[jplatform:application/component/view.php#cl-306|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::escape|Other versions of JView::escape]]
{{SeeAlso:JView::escape}}

<nowiki>[</nowiki>[[SeeAlso:JView::escape|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::escape
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::escape]]</noinclude>

API17:JView::display

2011-04-28T02:56:45Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::display==
===Description===
Execute and display a template script.

{{Description:JView::display}}

<nowiki>[</nowiki>[[Description:JView::display|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function display ($tpl=null)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$tpl
|object
|null
|An object.
|-
|}
* '''Returns'''
* '''Defined''' on line 180 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::display source code''' on [[jplatform:application/component/view.php#cl-172|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::display|Other versions of JView::display]]
{{SeeAlso:JView::display}}

<nowiki>[</nowiki>[[SeeAlso:JView::display|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::display
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::display]]</noinclude>

API17:JView::assignRef

2011-04-28T02:56:43Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::assignRef==
===Description===
Assign variable for the view (by reference).

{{Description:JView::assignRef}}

<nowiki>[</nowiki>[[Description:JView::assignRef|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function assignRef (
$key
&$val
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$key
|
|
|
|-
|&$val
|
|
|
|-
|}
* '''Returns'''
* '''Defined''' on line 294 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::assignRef source code''' on [[jplatform:application/component/view.php#cl-286|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::assignRef|Other versions of JView::assignRef]]
{{SeeAlso:JView::assignRef}}

<nowiki>[</nowiki>[[SeeAlso:JView::assignRef|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::assignRef
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::assignRef]]</noinclude>

API17:JView::assign

2011-04-28T02:56:40Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::assign==
===Description===
Assigns variables to the view script via differing strategies.

{{Description:JView::assign}}

<nowiki>[</nowiki>[[Description:JView::assign|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function assign ()
</source>
* '''Returns'''
* '''Defined''' on line 225 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::assign source code''' on [[jplatform:application/component/view.php#cl-217|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::assign|Other versions of JView::assign]]
{{SeeAlso:JView::assign}}

<nowiki>[</nowiki>[[SeeAlso:JView::assign|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::assign
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::assign]]</noinclude>

API17:JView::addTemplatePath

2011-04-28T02:56:36Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::addTemplatePath==
===Description===
Adds to the stack of view script paths in LIFO order.

{{Description:JView::addTemplatePath}}

<nowiki>[</nowiki>[[Description:JView::addTemplatePath|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function addTemplatePath ($path)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$path
|string|array
|
|The directory (-ies) to add.
|-
|}
* '''Returns''' void
* '''Defined''' on line 505 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::addTemplatePath source code''' on [[jplatform:application/component/view.php#cl-497|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::addTemplatePath|Other versions of JView::addTemplatePath]]
{{SeeAlso:JView::addTemplatePath}}

<nowiki>[</nowiki>[[SeeAlso:JView::addTemplatePath|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::addTemplatePath
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::addTemplatePath]]</noinclude>

API17:JView::addHelperPath

2011-04-28T02:56:33Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::addHelperPath==
===Description===
Adds to the stack of helper script paths in LIFO order.

{{Description:JView::addHelperPath}}

<nowiki>[</nowiki>[[Description:JView::addHelperPath|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function addHelperPath ($path)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$path
|string|array
|
|The directory (-ies) to add.
|-
|}
* '''Returns''' void
* '''Defined''' on line 516 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::addHelperPath source code''' on [[jplatform:application/component/view.php#cl-508|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::addHelperPath|Other versions of JView::addHelperPath]]
{{SeeAlso:JView::addHelperPath}}

<nowiki>[</nowiki>[[SeeAlso:JView::addHelperPath|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::addHelperPath
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::addHelperPath]]</noinclude>

API17:JView:: setPath

2011-04-28T02:56:29Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::_setPath==
===Description===
Sets an entire array of search paths for templates or resources.

{{Description:JView::_setPath}}

<nowiki>[</nowiki>[[Description:JView::_setPath|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
protected function _setPath (
$type
$path
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$type
|string
|
|The type of path to set, typically 'template'.
|-
|$path
|string|array
|
|The new set of search paths. If null or false, resets to the current directory only.
|-
|}
* '''Returns'''
* '''Defined''' on line 626 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::_setPath source code''' on [[jplatform:application/component/view.php#cl-618|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::_setPath|Other versions of JView::_setPath]]
{{SeeAlso:JView::_setPath}}

<nowiki>[</nowiki>[[SeeAlso:JView::_setPath|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::_setPath
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::_setPath]]</noinclude>

API17:JView:: addPath

2011-04-28T02:56:26Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::_addPath==
===Description===
Adds to the search path for templates and resources.

{{Description:JView::_addPath}}

<nowiki>[</nowiki>[[Description:JView::_addPath|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
protected function _addPath (
$type
$path
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$type
|string|array
|
|The directory or stream to search.
|-
|$path
|
|
|
|-
|}
* '''Returns'''
* '''Defined''' on line 658 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::_addPath source code''' on [[jplatform:application/component/view.php#cl-650|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::_addPath|Other versions of JView::_addPath]]
{{SeeAlso:JView::_addPath}}

<nowiki>[</nowiki>[[SeeAlso:JView::_addPath|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::_addPath
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::_addPath]]</noinclude>

API17:JView:: construct

2011-04-28T02:56:23Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JView::__construct==
===Description===
Constructor.

{{Description:JView::__construct}}

<nowiki>[</nowiki>[[Description:JView::__construct|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
protected function __construct ($config=array())
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$config
|
|array()
|
|-
|}
* '''Returns'''
* '''Defined''' on line 116 of libraries/joomla/application/component/view.php
===See also===
* {{JVer|11.1}} '''JView::__construct source code''' on [[jplatform:application/component/view.php#cl-108|BitBucket]]
* {{JVer|11.1}} Class [[JView/11.1|JView]]
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
* [[JView::__construct|Other versions of JView::__construct]]
{{SeeAlso:JView::__construct}}

<nowiki>[</nowiki>[[SeeAlso:JView::__construct|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JView::__construct
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JView]][[Category:JView::__construct]]</noinclude>

API17:JUtility::sendMail

2011-04-28T02:56:21Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::sendMail==
===Description===
Mail function (uses phpMailer).

{{Description:JUtility::sendMail}}

<nowiki>[</nowiki>[[Description:JUtility::sendMail|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function sendMail (
$from
$fromname
$recipient
$subject
$body
$mode=0
$cc=null
$bcc=null
$attachment=null
$replyto=null
$replytoname=null
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$from
|string
|
|From email address
|-
|$fromname
|string
|
|From name
|-
|$recipient
|mixed
|
|Recipient email address(es)
|-
|$subject
|string
|
|Email subject
|-
|$body
|string
|
|Message body
|-
|$mode
|boolean
|0
|false = plain text, true = HTML
|-
|$cc
|mixed
|null
|CC email address(es)
|-
|$bcc
|mixed
|null
|BCC email address(es)
|-
|$attachment
|mixed
|null
|Attachment file name(s)
|-
|$replyto
|mixed
|null
|Reply to email address(es)
|-
|$replytoname
|mixed
|null
|Reply to name(s)
|-
|}
* '''Returns''' boolean True on success
* '''Defined''' on line 43 of libraries/joomla/utilities/utility.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUtility::sendMail source code''' on [[jplatform:utilities/utility.php#cl-35|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::sendMail|Other versions of JUtility::sendMail]]
{{SeeAlso:JUtility::sendMail}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::sendMail|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::sendMail
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::sendMail]]</noinclude>

API17:JUtility::sendAdminMail

2011-04-28T02:56:18Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::sendAdminMail==
===Description===
Sends mail to administrator for approval of a user submission.

{{Description:JUtility::sendAdminMail}}

<nowiki>[</nowiki>[[Description:JUtility::sendAdminMail|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function sendAdminMail (
$adminName
$adminEmail
$email
$type
$title
$author
$url=null
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$adminName
|string
|
|Name of administrator
|-
|$adminEmail
|string
|
|Email address of administrator
|-
|$email
|string
|
|[NOT USED TODO: Deprecate?]
|-
|$type
|string
|
|Type of item to approve
|-
|$title
|string
|
|Title of item to approve
|-
|$author
|string
|
|Author of item to approve
|-
|$url
|
|null
|
|-
|}
* '''Returns''' boolean True on success
* '''Defined''' on line 69 of libraries/joomla/utilities/utility.php
===See also===
* {{JVer|11.1}} '''JUtility::sendAdminMail source code''' on [[jplatform:utilities/utility.php#cl-61|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::sendAdminMail|Other versions of JUtility::sendAdminMail]]
{{SeeAlso:JUtility::sendAdminMail}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::sendAdminMail|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::sendAdminMail
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::sendAdminMail]]</noinclude>

API17:JUtility::return bytes

2011-04-28T02:56:15Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::return_bytes==
===Description===
Return the byte value of a particular string.

{{Description:JUtility::return_bytes}}

<nowiki>[</nowiki>[[Description:JUtility::return_bytes|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function return_bytes ($val)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$val
|string
|
|String optionally with G, M or K suffix
|-
|}
* '''Returns''' int size in bytes
* '''Defined''' on line 207 of libraries/joomla/utilities/utility.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUtility::return_bytes source code''' on [[jplatform:utilities/utility.php#cl-199|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::return_bytes|Other versions of JUtility::return_bytes]]
{{SeeAlso:JUtility::return_bytes}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::return_bytes|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::return_bytes
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::return_bytes]]</noinclude>

API17:JUtility::parseAttributes

2011-04-28T02:56:12Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::parseAttributes==
===Description===
Method to extract key/value pairs out of a string with xml style attributes.

{{Description:JUtility::parseAttributes}}

<nowiki>[</nowiki>[[Description:JUtility::parseAttributes|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function parseAttributes ($string)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$string
|string
|
|String containing xml style attributes
|-
|}
* '''Returns''' array Key/Value pairs for the attributes
* '''Defined''' on line 121 of libraries/joomla/utilities/utility.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUtility::parseAttributes source code''' on [[jplatform:utilities/utility.php#cl-113|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::parseAttributes|Other versions of JUtility::parseAttributes]]
{{SeeAlso:JUtility::parseAttributes}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::parseAttributes|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::parseAttributes
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::parseAttributes]]</noinclude>

API17:JUtility::isWinOS

2011-04-28T02:56:09Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::isWinOS==
===Description===
Method to determine if the host OS is Windows.

{{Description:JUtility::isWinOS}}

<nowiki>[</nowiki>[[Description:JUtility::isWinOS|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function isWinOS ()
</source>
* '''Returns''' boolean True if Windows OS.
* '''Defined''' on line 150 of libraries/joomla/utilities/utility.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUtility::isWinOS source code''' on [[jplatform:utilities/utility.php#cl-142|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::isWinOS|Other versions of JUtility::isWinOS]]
{{SeeAlso:JUtility::isWinOS}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::isWinOS|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::isWinOS
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::isWinOS]]</noinclude>

API17:JUtility::getToken

2011-04-28T02:56:06Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::getToken==
===Description===
Method to determine a hash for anti-spoofing variable names.

{{Description:JUtility::getToken}}

<nowiki>[</nowiki>[[Description:JUtility::getToken|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function getToken ($forceNew=false)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$forceNew
|
|false
|
|-
|}
* '''Returns''' string Hashed var name
* '''Defined''' on line 105 of libraries/joomla/utilities/utility.php
* '''Since''' {{JVer|11.1 }}
* '''Referenced by'''
** [[JRequest::checkToken/11.1|JRequest::checkToken]]
** [[JCache::getWorkarounds/11.1|JCache::getWorkarounds]]
===See also===
* {{JVer|11.1}} '''JUtility::getToken source code''' on [[jplatform:utilities/utility.php#cl-97|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::getToken|Other versions of JUtility::getToken]]
{{SeeAlso:JUtility::getToken}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::getToken|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::getToken
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::getToken]]</noinclude>

API17:JUtility::getHash

2011-04-28T02:56:03Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::getHash==
===Description===
Provides a secure hash based on a seed.

{{Description:JUtility::getHash}}

<nowiki>[</nowiki>[[Description:JUtility::getHash|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function getHash ($seed)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$seed
|string
|
|Seed string.
|-
|}
* '''Returns''' string
* '''Defined''' on line 89 of libraries/joomla/utilities/utility.php
* '''Referenced by'''
** [[JApplication::__construct/11.1|JApplication::__construct]]
===See also===
* {{JVer|11.1}} '''JUtility::getHash source code''' on [[jplatform:utilities/utility.php#cl-81|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::getHash|Other versions of JUtility::getHash]]
{{SeeAlso:JUtility::getHash}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::getHash|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::getHash
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::getHash]]</noinclude>

API17:JUtility::dump

2011-04-28T02:56:00Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::dump==
===Description===
Method to dump the structure of a variable for debugging purposes.

{{Description:JUtility::dump}}

<nowiki>[</nowiki>[[Description:JUtility::dump|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function dump (
&$var
$htmlSafe=true
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|&$var
|mixed
|
|$var A variable
|-
|$htmlSafe
|boolean
|true
|True to ensure all characters are htmlsafe
|-
|}
* '''Returns''' string
* '''Defined''' on line 168 of libraries/joomla/utilities/utility.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUtility::dump source code''' on [[jplatform:utilities/utility.php#cl-160|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::dump|Other versions of JUtility::dump]]
{{SeeAlso:JUtility::dump}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::dump|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::dump
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::dump]]</noinclude>

API17:JUtility::array unshift ref

2011-04-28T02:55:57Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUtility::array_unshift_ref==
===Description===
Prepend a reference to an element to the beginning of an array.

{{Description:JUtility::array_unshift_ref}}

<nowiki>[</nowiki>[[Description:JUtility::array_unshift_ref|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function array_unshift_ref (
&$array
&$value
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|&$array
|
|
|
|-
|&$value
|
|
|
|-
|}
* '''Returns'''
* '''Defined''' on line 188 of libraries/joomla/utilities/utility.php
===See also===
* {{JVer|11.1}} '''JUtility::array_unshift_ref source code''' on [[jplatform:utilities/utility.php#cl-180|BitBucket]]
* {{JVer|11.1}} Class [[JUtility/11.1|JUtility]]
* {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]]
* [[JUtility::array_unshift_ref|Other versions of JUtility::array_unshift_ref]]
{{SeeAlso:JUtility::array_unshift_ref}}

<nowiki>[</nowiki>[[SeeAlso:JUtility::array_unshift_ref|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUtility::array_unshift_ref
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUtility]][[Category:JUtility::array_unshift_ref]]</noinclude>

API17:JUserHelper::setUserGroups

2011-04-28T02:55:55Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::setUserGroups==
===Description===
Method to set the groups for a user.

{{Description:JUserHelper::setUserGroups}}

<nowiki>[</nowiki>[[Description:JUserHelper::setUserGroups|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function setUserGroups (
$userId
$groups
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$userId
|integer
|
|The id of the user.
|-
|$groups
|array
|
|An array of group ids to put the user in.
|-
|}
* '''Returns''' mixed Boolean true on success, on error.
* '''Defined''' on line 146 of libraries/joomla/user/helper.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUserHelper::setUserGroups source code''' on [[jplatform:user/helper.php#cl-138|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::setUserGroups|Other versions of JUserHelper::setUserGroups]]
{{SeeAlso:JUserHelper::setUserGroups}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::setUserGroups|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::setUserGroups
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::setUserGroups]]</noinclude>

API17:JUserHelper::removeUserFromGroup

2011-04-28T02:55:52Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::removeUserFromGroup==
===Description===
Method to remove a user from a group.

{{Description:JUserHelper::removeUserFromGroup}}

<nowiki>[</nowiki>[[Description:JUserHelper::removeUserFromGroup|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function removeUserFromGroup (
$userId
$groupId
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$userId
|integer
|
|The id of the user.
|-
|$groupId
|integer
|
|The id of the group.
|-
|}
* '''Returns''' mixed Boolean true on success, on error.
* '''Defined''' on line 107 of libraries/joomla/user/helper.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUserHelper::removeUserFromGroup source code''' on [[jplatform:user/helper.php#cl-99|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::removeUserFromGroup|Other versions of JUserHelper::removeUserFromGroup]]
{{SeeAlso:JUserHelper::removeUserFromGroup}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::removeUserFromGroup|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::removeUserFromGroup
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::removeUserFromGroup]]</noinclude>

API17:JUserHelper::getUserId

2011-04-28T02:55:49Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::getUserId==
===Description===
Returns userid if a user exists.

{{Description:JUserHelper::getUserId}}

<nowiki>[</nowiki>[[Description:JUserHelper::getUserId|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function getUserId ($username)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$username
|string
|
|The username to search on
|-
|}
* '''Returns''' int The user id or 0 if not found
* '''Defined''' on line 271 of libraries/joomla/user/helper.php
* '''Referenced by'''
** [[JUser::getInstance/11.1|JUser::getInstance]]
===See also===
* {{JVer|11.1}} '''JUserHelper::getUserId source code''' on [[jplatform:user/helper.php#cl-263|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::getUserId|Other versions of JUserHelper::getUserId]]
{{SeeAlso:JUserHelper::getUserId}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getUserId|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::getUserId
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getUserId]]</noinclude>

API17:JUserHelper::getUserGroups

2011-04-28T02:55:46Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::getUserGroups==
===Description===
Method to get a list of groups a user is in.

{{Description:JUserHelper::getUserGroups}}

<nowiki>[</nowiki>[[Description:JUserHelper::getUserGroups|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function getUserGroups ($userId)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$userId
|integer
|
|The id of the user.
|-
|}
* '''Returns''' mixed Array on success, on error.
* '''Defined''' on line 91 of libraries/joomla/user/helper.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUserHelper::getUserGroups source code''' on [[jplatform:user/helper.php#cl-83|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::getUserGroups|Other versions of JUserHelper::getUserGroups]]
{{SeeAlso:JUserHelper::getUserGroups}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getUserGroups|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::getUserGroups
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getUserGroups]]</noinclude>

API17:JUserHelper::getSalt

2011-04-28T02:55:43Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::getSalt==
===Description===
Returns a salt for the appropriate kind of password encryption.

{{Description:JUserHelper::getSalt}}

<nowiki>[</nowiki>[[Description:JUserHelper::getSalt|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function getSalt (
$encryption= 'md5-hex'
$seed= ''
$plaintext= ''
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$encryption
|
|'md5-hex'
|
|-
|$seed
|
|''
|
|-
|$plaintext
|
|''
|
|-
|}
* '''Returns'''
* '''Defined''' on line 390 of libraries/joomla/user/helper.php
* '''Referenced by'''
** [[getCryptedPassword/11.1|getCryptedPassword]]
===See also===
* {{JVer|11.1}} '''JUserHelper::getSalt source code''' on [[jplatform:user/helper.php#cl-382|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::getSalt|Other versions of JUserHelper::getSalt]]
{{SeeAlso:JUserHelper::getSalt}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getSalt|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::getSalt
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getSalt]]</noinclude>

API17:JUserHelper::getProfile

2011-04-28T02:55:40Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::getProfile==
===Description===
Gets the user profile information.

{{Description:JUserHelper::getProfile}}

<nowiki>[</nowiki>[[Description:JUserHelper::getProfile|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function getProfile ($userId=0)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$userId
|
|0
|
|-
|}
* '''Returns'''
* '''Defined''' on line 195 of libraries/joomla/user/helper.php
===See also===
* {{JVer|11.1}} '''JUserHelper::getProfile source code''' on [[jplatform:user/helper.php#cl-187|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::getProfile|Other versions of JUserHelper::getProfile]]
{{SeeAlso:JUserHelper::getProfile}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getProfile|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::getProfile
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getProfile]]</noinclude>

API17:JUserHelper::getCryptedPassword

2011-04-28T02:55:37Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::getCryptedPassword==
===Description===
Formats a password using the current encryption.

{{Description:JUserHelper::getCryptedPassword}}

<nowiki>[</nowiki>[[Description:JUserHelper::getCryptedPassword|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function getCryptedPassword (
$plaintext
$salt= ''
$encryption= 'md5-hex'
$show_encrypt=false
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$plaintext
|string
|
|The plaintext password to encrypt.
|-
|$salt
|string
|''
|The salt to use to encrypt the password. [] If not present, a new salt will be generated.
|-
|$encryption
|string
|'md5-hex'
|The kind of pasword encryption to use. Defaults to md5-hex.
|-
|$show_encrypt
|boolean
|false
|Some password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.
|-
|}
* '''Returns''' string The encrypted password.
* '''Defined''' on line 296 of libraries/joomla/user/helper.php
* '''Referenced by'''
** [[JUser::bind/11.1|JUser::bind]]
===See also===
* {{JVer|11.1}} '''JUserHelper::getCryptedPassword source code''' on [[jplatform:user/helper.php#cl-288|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::getCryptedPassword|Other versions of JUserHelper::getCryptedPassword]]
{{SeeAlso:JUserHelper::getCryptedPassword}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getCryptedPassword|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::getCryptedPassword
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getCryptedPassword]]</noinclude>

API17:JUserHelper::genRandomPassword

2011-04-28T02:55:34Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::genRandomPassword==
===Description===
Generate a random password.

{{Description:JUserHelper::genRandomPassword}}

<nowiki>[</nowiki>[[Description:JUserHelper::genRandomPassword|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function genRandomPassword ($length=8)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$length
|int
|8
|Length of the password to generate
|-
|}
* '''Returns''' string Random Password
* '''Defined''' on line 471 of libraries/joomla/user/helper.php
* '''Since''' {{JVer|11.1 }}
* '''Referenced by'''
** [[JUser::bind/11.1|JUser::bind]]
** [[JPath::isOwner/11.1|JPath::isOwner]]
===See also===
* {{JVer|11.1}} '''JUserHelper::genRandomPassword source code''' on [[jplatform:user/helper.php#cl-463|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::genRandomPassword|Other versions of JUserHelper::genRandomPassword]]
{{SeeAlso:JUserHelper::genRandomPassword}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::genRandomPassword|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::genRandomPassword
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::genRandomPassword]]</noinclude>

API17:JUserHelper::addUserToGroup

2011-04-28T02:55:31Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::addUserToGroup==
===Description===
Method to add a user to a group.

{{Description:JUserHelper::addUserToGroup}}

<nowiki>[</nowiki>[[Description:JUserHelper::addUserToGroup|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function addUserToGroup (
$userId
$groupId
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$userId
|integer
|
|The id of the user.
|-
|$groupId
|integer
|
|The id of the group.
|-
|}
* '''Returns''' mixed Boolean true on success, on error.
* '''Defined''' on line 35 of libraries/joomla/user/helper.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUserHelper::addUserToGroup source code''' on [[jplatform:user/helper.php#cl-27|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::addUserToGroup|Other versions of JUserHelper::addUserToGroup]]
{{SeeAlso:JUserHelper::addUserToGroup}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::addUserToGroup|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::addUserToGroup
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::addUserToGroup]]</noinclude>

API17:JUserHelper::activateUser

2011-04-28T02:55:28Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUserHelper::activateUser==
===Description===
Method to activate a user.

{{Description:JUserHelper::activateUser}}

<nowiki>[</nowiki>[[Description:JUserHelper::activateUser|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public static function activateUser ($activation)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$activation
|string
|
|Activation string
|-
|}
* '''Returns''' boolean True on success
* '''Defined''' on line 225 of libraries/joomla/user/helper.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUserHelper::activateUser source code''' on [[jplatform:user/helper.php#cl-217|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::activateUser|Other versions of JUserHelper::activateUser]]
{{SeeAlso:JUserHelper::activateUser}}

<nowiki>[</nowiki>[[SeeAlso:JUserHelper::activateUser|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUserHelper::activateUser
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::activateUser]]</noinclude>

API17:JUser::setParameters

2011-04-28T02:55:25Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUser::setParameters==
===Description===
Method to get the user parameters.

{{Description:JUser::setParameters}}

<nowiki>[</nowiki>[[Description:JUser::setParameters|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setParameters ($params)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$params
|object
|
|The user parameters object
|-
|}
* '''Returns''' void
* '''Defined''' on line 449 of libraries/joomla/user/user.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUser::setParameters source code''' on [[jplatform:user/user.php#cl-441|BitBucket]]
* {{JVer|11.1}} Class [[JUser/11.1|JUser]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUser::setParameters|Other versions of JUser::setParameters]]
{{SeeAlso:JUser::setParameters}}

<nowiki>[</nowiki>[[SeeAlso:JUser::setParameters|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUser::setParameters
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUser]][[Category:JUser::setParameters]]</noinclude>

API17:JUser::setParam

2011-04-28T02:55:22Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUser::setParam==
===Description===
Method to set a parameter.

{{Description:JUser::setParam}}

<nowiki>[</nowiki>[[Description:JUser::setParam|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setParam (
$key
$value
)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$key
|string
|
|Parameter key
|-
|$value
|mixed
|
|Parameter value
|-
|}
* '''Returns''' mixed Set parameter value
* '''Defined''' on line 240 of libraries/joomla/user/user.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUser::setParam source code''' on [[jplatform:user/user.php#cl-232|BitBucket]]
* {{JVer|11.1}} Class [[JUser/11.1|JUser]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUser::setParam|Other versions of JUser::setParam]]
{{SeeAlso:JUser::setParam}}

<nowiki>[</nowiki>[[SeeAlso:JUser::setParam|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUser::setParam
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUser]][[Category:JUser::setParam]]</noinclude>

API17:JUser::setLastVisit

2011-04-28T02:55:19Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUser::setLastVisit==
===Description===
Pass through method to the table for setting the last visit date.

{{Description:JUser::setLastVisit}}

<nowiki>[</nowiki>[[Description:JUser::setLastVisit|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function setLastVisit ($timestamp=null)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$timestamp
|int
|null
|The timestamp, defaults to 'now'.
|-
|}
* '''Returns''' boolean True on success.
* '''Defined''' on line 391 of libraries/joomla/user/user.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUser::setLastVisit source code''' on [[jplatform:user/user.php#cl-383|BitBucket]]
* {{JVer|11.1}} Class [[JUser/11.1|JUser]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUser::setLastVisit|Other versions of JUser::setLastVisit]]
{{SeeAlso:JUser::setLastVisit}}

<nowiki>[</nowiki>[[SeeAlso:JUser::setLastVisit|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUser::setLastVisit
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUser]][[Category:JUser::setLastVisit]]</noinclude>

API17:JUser::save

2011-04-28T02:55:14Z

Doxiki2: Updated to r1448:247ba8d88526

__NOTOC__
=={{JVer|11.1}} JUser::save==
===Description===
Method to save the object to the database.

{{Description:JUser::save}}

<nowiki>[</nowiki>[[Description:JUser::save|Edit Descripton]]<nowiki>]</nowiki>

<source lang="php">
public function save ($updateOnly=false)
</source>
{| class="wikitable"
|-
!Parameter
!Type
!Default
!Description
|-
|$updateOnly
|boolean
|false
|Save the object only if not a new user
|-
|}
* '''Returns''' boolean True on success
* '''Defined''' on line 595 of libraries/joomla/user/user.php
* '''Since''' {{JVer|11.1 }}
===See also===
* {{JVer|11.1}} '''JUser::save source code''' on [[jplatform:user/user.php#cl-587|BitBucket]]
* {{JVer|11.1}} Class [[JUser/11.1|JUser]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUser::save|Other versions of JUser::save]]
{{SeeAlso:JUser::save}}

<nowiki>[</nowiki>[[SeeAlso:JUser::save|Edit See Also]]<nowiki>]</nowiki>

===User contributed notes===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JUser::save
category=CodeExample
category=MethodExample
include=*
namespace=CodeExample
format= ,,,
</dpl>
<noinclude>[[Category:JUser]][[Category:JUser::save]]</noinclude>