Joomla! Documentation - User contributions [en]

API16:JUtility/array unshift ref

2010-03-30T10:19:51Z

Doxiki:

===Description===
Prepend a reference to an element to the beginning of an array. Renumbers numeric keys, so $value is always inserted to $array[0]


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


{{Description:JUtility/array_unshift_ref}}

===Syntax===
<source lang="php">array_unshift_ref(&$array, &$value)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$array
|
| array
|-
| &$value
|
| mixed
|}

===Returns===
int

===Defined in===
libraries/joomla/utilities/utility.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.utility' );</source>

===Source Body===
<source lang="php">
function array_unshift_ref(&$array, &$value)
{
$return = array_unshift($array,'');
$array[0] =& $value;
return $return;
}
</source>


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

{{SeeAlso:JUtility/array_unshift_ref}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=array_unshift_ref
category=JUtility
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JUtility/dump

2010-03-30T10:19:50Z

Doxiki:

===Description===
Method to dump the structure of a variable for debugging purposes


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


{{Description:JUtility/dump}}

===Syntax===
<source lang="php">dump(&$var, $htmlSafe=true)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$var
|
| A variable
|-
| $htmlSafe
| true
| True to ensure all characters are htmlsafe
|}

===Returns===
string

===Defined in===
libraries/joomla/utilities/utility.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.utility' );</source>

===Source Body===
<source lang="php">
function dump(&$var, $htmlSafe = true)
{
$result = var_export($var, true);
return '<pre>'.($htmlSafe ? htmlspecialchars($result, ENT_COMPAT, 'UTF-8') : $result).'</pre>';
}
</source>


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

{{SeeAlso:JUtility/dump}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=dump
category=JUtility
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JSimpleXMLElement/removeChild

2010-03-30T10:19:43Z

Doxiki:

<nowiki>[</nowiki>[[Description:JSimpleXMLElement/removeChild|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JSimpleXMLElement/removeChild}}

===Syntax===
<source lang="php">removeChild(&$child)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$child
|
|
|}

===Defined in===
libraries/joomla/utilities/simplexml.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.simplexml' );</source>

===Source Body===
<source lang="php">
function removeChild(&$child)
{
$name = $child->name();
for ($i=0,$n=count($this->_children);$i<$n;$i++)
{
if ($this->_children[$i] == $child) {
unset($this->_children[$i]);
}
}
for ($i=0,$n=count($this->{$name});$i<$n;$i++)
{
if ($this->{$name}[$i] == $child) {
unset($this->{$name}[$i]);
}
}
$this->_children = array_values($this->_children);
$this->{$name} = array_values($this->{$name});
unset($child);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JSimpleXMLElement/removeChild|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JSimpleXMLElement/removeChild}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=removeChild
category=JSimpleXMLElement
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JBuffer/stream open

2010-03-30T10:19:19Z

Doxiki:

<nowiki>[</nowiki>[[Description:JBuffer/stream_open|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JBuffer/stream_open}}

===Syntax===
<source lang="php">stream_open($path, $mode, $options, &$opened_path)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $path
|
|
|-
| $mode
|
|
|-
| $options
|
|
|-
| &$opened_path
|
|
|}

===Defined in===
libraries/joomla/utilities/buffer.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.buffer' );</source>

===Source Body===
<source lang="php">
function stream_open($path, $mode, $options, & $opened_path)
{
$url = parse_url($path);
$this->name = $url["host"];
$this->_buffers[$this->name] = null;
$this->position = 0;

return true;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JBuffer/stream_open|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JBuffer/stream_open}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=stream_open
category=JBuffer
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JArrayHelper/sortObjects

2010-03-30T10:19:18Z

Doxiki:

===Description===
Utility function to sort an array of objects on a given field


<nowiki>[</nowiki>[[Description:JArrayHelper/sortObjects|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JArrayHelper/sortObjects}}

===Syntax===
<source lang="php">sortObjects(&$a, $k, $direction=1)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$a
|
| $arr An array of objects
|-
| $k
|
| $k The key to sort on
|-
| $direction
| 1
| $direction Direction to sort in [1 = Ascending] [-1 = Descending]
|}

===Returns===
array The sorted array of objects

===Defined in===
libraries/joomla/utilities/arrayhelper.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.arrayhelper' );</source>

===Source Body===
<source lang="php">
function sortObjects(&$a, $k, $direction=1)
{
$GLOBALS['JAH_so'] = array(
'key' => $k,
'direction' => $direction
);
usort($a, array('JArrayHelper', '_sortObjects'));
unset($GLOBALS['JAH_so']);

return $a;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JArrayHelper/sortObjects|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JArrayHelper/sortObjects}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=sortObjects
category=JArrayHelper
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JArrayHelper/getValue

2010-03-30T10:19:18Z

Doxiki:

===Description===
Utility function to return a value from a named array or a specified default


<nowiki>[</nowiki>[[Description:JArrayHelper/getValue|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JArrayHelper/getValue}}

===Syntax===
<source lang="php">getValue(&$array, $name, $default=null, $type='')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$array
|
| $array A named array
|-
| $name
|
| $name The key to search for
|-
| $default
| null
| $default The default value to give if no key found
|-
| $type
| ''
| $type Return type for the variable (INT, FLOAT, STRING, WORD, BOOLEAN, ARRAY)
|}

===Returns===
mixed The value from the source array

===Defined in===
libraries/joomla/utilities/arrayhelper.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.arrayhelper' );</source>

===Source Body===
<source lang="php">
function getValue(&$array, $name, $default=null, $type='')
{
// Initialise variables.
$result = null;

if (isset ($array[$name])) {
$result = $array[$name];
}

// Handle the default case
if (is_null($result)) {
$result = $default;
}

// Handle the type constraint
switch (strtoupper($type))
{
case 'INT' :
case 'INTEGER' :
// Only use the first integer value
@ preg_match('/-?[0-9]+/', $result, $matches);
$result = @ (int) $matches[0];
break;

case 'FLOAT' :
case 'DOUBLE' :
// Only use the first floating point value
@ preg_match('/-?[0-9]+(\.[0-9]+)?/', $result, $matches);
$result = @ (float) $matches[0];
break;

case 'BOOL' :
case 'BOOLEAN' :
$result = (bool) $result;
break;

case 'ARRAY' :
if (!is_array($result)) {
$result = array ($result);
}
break;

case 'STRING' :
$result = (string) $result;
break;

case 'WORD' :
$result = (string) preg_replace('#\W#', '', $result);
break;

case 'NONE' :
default :
// No casting necessary
break;
}
return $result;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JArrayHelper/getValue|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JArrayHelper/getValue}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=getValue
category=JArrayHelper
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JArrayHelper/getColumn

2010-03-30T10:19:17Z

Doxiki:

===Description===
Extracts a column from an array of arrays or objects


<nowiki>[</nowiki>[[Description:JArrayHelper/getColumn|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JArrayHelper/getColumn}}

===Syntax===
<source lang="php">getColumn(&$array, $index)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$array
|
| $array The source array
|-
| $index
|
| $index The index of the column or name of object property
|}

===Returns===
array Column of values from the source array

===Defined in===
libraries/joomla/utilities/arrayhelper.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.arrayhelper' );</source>

===Source Body===
<source lang="php">
function getColumn(&$array, $index)
{
$result = array ();

if (is_array($array))
{
$n = count($array);
for ($i = 0; $i < $n; $i++)
{
$item = & $array[$i];
if (is_array($item) && isset ($item[$index])) {
$result[] = $item[$index];
} elseif (is_object($item) && isset ($item-> $index)) {
$result[] = $item-> $index;
}
// else ignore the entry
}
}
return $result;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JArrayHelper/getColumn|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JArrayHelper/getColumn}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=getColumn
category=JArrayHelper
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JArrayHelper/toObject

2010-03-30T10:19:15Z

Doxiki:

===Description===
Utility function to map an array to a stdClass object.


<nowiki>[</nowiki>[[Description:JArrayHelper/toObject|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JArrayHelper/toObject}}

===Syntax===
<source lang="php">static toObject(&$array, $class= 'stdClass')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$array
|
| $array The array to map.
|-
| $class
| 'stdClass'
| $calss Name of the class to create
|}

===Returns===
object The object mapped from the given array

===Defined in===
libraries/joomla/utilities/arrayhelper.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.arrayhelper' );</source>

===Source Body===
<source lang="php">
static function toObject(&$array, $class = 'stdClass')
{
$obj = null;
if (is_array($array))
{
$obj = new $class();
foreach ($array as $k => $v)
{
if (is_array($v)) {
$obj->$k = JArrayHelper::toObject($v, $class);
} else {
$obj->$k = $v;
}
}
}
return $obj;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JArrayHelper/toObject|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JArrayHelper/toObject}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=toObject
category=JArrayHelper
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JArrayHelper/toInteger

2010-03-30T10:19:14Z

Doxiki:

===Description===
Function to convert array to integer values


<nowiki>[</nowiki>[[Description:JArrayHelper/toInteger|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JArrayHelper/toInteger}}

===Syntax===
<source lang="php">static toInteger(&$array, $default=null)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$array
|
| $array The source array to convert
|-
| $default
| null
| $default A default value (int|array) to assign if $array is not an array
|}

===Defined in===
libraries/joomla/utilities/arrayhelper.php
===Importing===
<source lang="php">jimport( 'joomla.utilities.arrayhelper' );</source>

===Source Body===
<source lang="php">
static function toInteger(&$array, $default = null)
{
if (is_array($array)) {
foreach ($array as $i => $v) {
$array[$i] = (int) $v;
}
} else {
if ($default === null) {
$array = array();
} elseif (is_array($default)) {
JArrayHelper::toInteger($default, null);
$array = $default;
} else {
$array = array((int) $default);
}
}
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JArrayHelper/toInteger|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JArrayHelper/toInteger}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=toInteger
category=JArrayHelper
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JRegistry/merge

2010-03-30T10:18:53Z

Doxiki:

===Description===
Merge a JRegistry object into this one


<nowiki>[</nowiki>[[Description:JRegistry/merge|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JRegistry/merge}}

===Syntax===
<source lang="php">merge(&$source)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$source
|
| Source object ot merge
|}

===Returns===
boolean True on success

===Defined in===
libraries/joomla/registry/registry.php
===Importing===
<source lang="php">jimport( 'joomla.registry.registry' );</source>

===Source Body===
<source lang="php">
public function merge(&$source)
{
if ($source instanceof JRegistry) {
$sns = $source->getNameSpaces();
foreach ($sns as $ns) {
if (!isset($this->_registry[$ns])) {
// If namespace does not exist, make it and load the data
$this->makeNameSpace($ns);
}

// Load the variables into the registry's default namespace.
foreach ($source->toArray($ns) as $k => $v) {
if ($v != null) {
$this->_registry[$ns]['data']->$k = $v;
}
}
}
return true;
}
return false;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JRegistry/merge|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JRegistry/merge}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=merge
category=JRegistry
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JRegistry/loadObject

2010-03-30T10:18:49Z

Doxiki:

===Description===
Load the public variables of the object into the default namespace.


<nowiki>[</nowiki>[[Description:JRegistry/loadObject|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JRegistry/loadObject}}

===Syntax===
<source lang="php">loadObject(&$object, $namespace=null)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$object
|
| The object holding the public vars to load
|-
| $namespace
| null
| Namespace to load the INI string into [optional]
|}

===Returns===
boolean True on success

===Defined in===
libraries/joomla/registry/registry.php
===Importing===
<source lang="php">jimport( 'joomla.registry.registry' );</source>

===Source Body===
<source lang="php">
public function loadObject(&$object, $namespace = null)
{
// If namespace is not set, get the default namespace
if ($namespace == null) {
$namespace = $this->_defaultNameSpace;
}

if (!isset($this->_registry[$namespace])) {
// If namespace does not exist, make it and load the data
$this->makeNameSpace($namespace);
}

/*
* We want to leave groups that are already in the namespace and add the
* groups loaded into the namespace. This overwrites any existing group
* with the same name
*/
if (is_object($object)) {
foreach (get_object_vars($object) as $k => $v) {
if (substr($k, 0,1) != '_' || $k == '_name') {
$this->_registry[$namespace]['data']->$k = $v;
}
}
}

return true;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JRegistry/loadObject|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JRegistry/loadObject}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=loadObject
category=JRegistry
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JText/

2010-03-30T10:18:38Z

Doxiki: New page: ===Description=== Translates a string into the current language. <nowiki>[</nowiki>Edit Descripton<nowiki>]</...

===Description===
Translates a string into the current language.


<nowiki>[</nowiki>[[Description:JText/_|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JText/_}}

===Syntax===
<source lang="php">static _($string, $jsSafe=false)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $string
|
| $string The string to translate.
|-
| $jsSafe
| false
| $jsSafe Make the result javascript safe.
|}

===Defined in===
libraries/joomla/methods.php
===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>

===Source Body===
<source lang="php">
public static function _($string, $jsSafe = false)
{
$lang = &JFactory::getLanguage();
return $lang->_($string, $jsSafe);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JText/_|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JText/_}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=_
category=JText
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JText

2010-03-30T10:18:37Z

Doxiki:

<nowiki>[</nowiki>[[Description:JText|Edit Descripton]]<nowiki>]</nowiki>

{{Description:JText}}

===Defined in===
libraries/joomla/methods.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API16:JText/_|_]]
|Translates a string into the current language.
|-
|[[API16:JText/sprintf|sprintf]]
|Passes a string thru an sprintf.
|-
|[[API16:JText/printf|printf]]
|Passes a string thru an printf.
|-
|[[API16:JText/script|script]]
|Translate a string into the current language and stores it in the JavaScript language store.
|}

===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>


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

{{SeeAlso:JText}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JText
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

API16:JRoute/

2010-03-30T10:18:36Z

Doxiki: New page: ===Description=== Translates an internal Joomla URL to a humanly readible URL. <nowiki>[</nowiki>[[Description:JRoute/_|Edit Descript...

===Description===
Translates an internal Joomla URL to a humanly readible URL.


<nowiki>[</nowiki>[[Description:JRoute/_|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JRoute/_}}

===Syntax===
<source lang="php">static _($url, $xhtml=true, $ssl=null)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $url
|
| $url Absolute or Relative URI to resource.
|-
| $xhtml
| true
| $xhtml Replace & by & for xml compilance.
|-
| $ssl
| null
| $ssl Secure state for the resolved URI. 1: Make URI secure using global secure site URI. 0: Leave URI in the same secure state as it was passed to the function. -1: Make URI unsecure using the global unsecure site URI.
|}

===Returns===
The translated humanly readible URL.

===Defined in===
libraries/joomla/methods.php
===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>

===Source Body===
<source lang="php">
public static function _($url, $xhtml = true, $ssl = null)
{
// Get the router.
$app = &JFactory::getApplication();
$router = &$app->getRouter();

// Make sure that we have our router
if (!$router) {
return null;
}

if ((strpos($url, '&') !== 0) && (strpos($url, 'index.php') !== 0)) {
return $url;
}

// Build route.
$uri = &$router->build($url);
$url = $uri->toString(array('path', 'query', 'fragment'));

// Replace spaces.
$url = preg_replace('/\s/u', '%20', $url);

/*
* Get the secure/unsecure URLs.
*
* If the first 5 characters of the BASE are 'https', then we are on an ssl connection over
* https and need to set our secure URL to the current request URL, if not, and the scheme is
* 'http', then we need to do a quick string manipulation to switch schemes.
*/
if ((int) $ssl)
{
$uri = &JURI::getInstance();

// Get additional parts.
static $prefix;
if (!$prefix)
{
$prefix = $uri->toString(array('host', 'port'));
}

// Determine which scheme we want.
$scheme = ($ssl === 1) ? 'https' : 'http';

// Make sure our URL path begins with a slash.
if (!preg_match('#^/#', $url)) {
$url = '/'.$url;
}

// Build the URL.
$url = $scheme.'://'.$prefix.$url;
}

if ($xhtml) {
$url = str_replace('&', '&', $url);
}

return $url;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JRoute/_|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JRoute/_}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=_
category=JRoute
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JRoute

2010-03-30T10:18:34Z

Doxiki:

<nowiki>[</nowiki>[[Description:JRoute|Edit Descripton]]<nowiki>]</nowiki>

{{Description:JRoute}}

===Defined in===
libraries/joomla/methods.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API16:JRoute/_|_]]
|Translates an internal Joomla URL to a humanly readible URL.
|}

===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>


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

{{SeeAlso:JRoute}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JRoute
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

API16:JPlugin/ construct

2010-03-30T10:17:42Z

Doxiki:

===Description===
Constructor


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


{{Description:JPlugin/__construct}}

===Syntax===
<source lang="php">__construct(&$subject, $config=array())</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$subject
|
| $subject The object to observe
|-
| $config
| array()
| $config An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params' (this list is not meant to be comprehensive).
|}

===Defined in===
libraries/joomla/plugin/plugin.php
===Importing===
<source lang="php">jimport( 'joomla.plugin.plugin' );</source>

===Source Body===
<source lang="php">
public function __construct(&$subject, $config = array())
{
// Get the parameters.
if (isset($config['params']))
{
if ($config['params'] instanceof JParameter) {
$this->params = $config['params'];
} else {
$this->params = new JParameter($config['params']);
}
}

// Get the plugin name.
if (isset($config['name'])) {
$this->_name = $config['name'];
}

// Get the plugin type.
if (isset($config['type'])) {
$this->_type = $config['type'];
}
$events = get_class_methods($this);
foreach($events as $event)
{
$method = array('event' => $event, 'handler' => array($this, 'onFireEvent'));
$subject->attach($method);
}
parent::__construct($subject);
}
</source>


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

{{SeeAlso:JPlugin/__construct}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=__construct
category=JPlugin
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JButtonSeparator/render

2010-03-30T10:17:17Z

Doxiki:

<nowiki>[</nowiki>[[Description:JButtonSeparator/render|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JButtonSeparator/render}}

===Syntax===
<source lang="php">render(&$definition)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$definition
|
|
|}

===Defined in===
libraries/joomla/html/toolbar/button/separator.php
===Importing===
<source lang="php">jimport( 'joomla.html.toolbar.button.separator' );</source>

===Source Body===
<source lang="php">
public function render(&$definition)
{
// Initialise variables.
$class = null;
$style = null;

// Separator class name
$class = (empty($definition[1])) ? 'spacer' : $definition[1];
// Custom width
$style = (empty($definition[2])) ? null : ' style="width:' . intval($definition[2]) . 'px;"';

return '<li class="' . $class . '"' . $style . ">\n</li>\n";
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JButtonSeparator/render|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JButtonSeparator/render}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=render
category=JButtonSeparator
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JButton/render

2010-03-30T10:17:00Z

Doxiki:

<nowiki>[</nowiki>[[Description:JButton/render|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JButton/render}}

===Syntax===
<source lang="php">render(&$definition)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$definition
|
|
|}

===Defined in===
libraries/joomla/html/toolbar/button.php
===Importing===
<source lang="php">jimport( 'joomla.html.toolbar.button' );</source>

===Source Body===
<source lang="php">
public function render(&$definition)
{
/*
* Initialise some variables
*/
$html = null;
$id = call_user_func_array(array(&$this, 'fetchId'), $definition);
$action = call_user_func_array(array(&$this, 'fetchButton'), $definition);

// Build id attribute
if ($id) {
$id = "id=\"$id\"";
}

// Build the HTML Button
$html .= "<li class=\"button\" $id>\n";
$html .= $action;
$html .= "</li>\n";

return $html;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JButton/render|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JButton/render}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=render
category=JButton
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JToolBar/renderButton

2010-03-30T10:16:56Z

Doxiki:

===Description===
Render a parameter type.


<nowiki>[</nowiki>[[Description:JToolBar/renderButton|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JToolBar/renderButton}}

===Syntax===
<source lang="php">renderButton(&$node)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$node
|
| A param tag node.
|}

===Returns===
array Any array of the label, the form element and the tooltip.

===Defined in===
libraries/joomla/html/toolbar.php
===Importing===
<source lang="php">jimport( 'joomla.html.toolbar' );</source>

===Source Body===
<source lang="php">
public function renderButton(&$node)
{
// Get the button type.
$type = $node[0];

$button = &$this->loadButtonType($type);

// Check for error.
if ($button === false) {
return JText::_('Button not defined for type').' = '.$type;
}
return $button->render($node);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JToolBar/renderButton|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JToolBar/renderButton}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=renderButton
category=JToolBar
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementTimezones/fetchElement

2010-03-30T10:16:50Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementTimezones/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementTimezones/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/timezones.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.timezones' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
if (!strlen($value)) {
$conf = &JFactory::getConfig();
$value = $conf->getValue('config.offset');
}

// LOCALE SETTINGS
$timezones = array (
JHtml::_('select.option', -12, JText::_('UTC__12_00__INTERNATIONAL_DATE_LINE_WEST')),
JHtml::_('select.option', -11, JText::_('UTC__11_00__MIDWAY_ISLAND__SAMOA')),
JHtml::_('select.option', -10, JText::_('UTC__10_00__HAWAII')),
JHtml::_('select.option', -9.5, JText::_('UTC__09_30__TAIOHAE__MARQUESAS_ISLANDS')),
JHtml::_('select.option', -9, JText::_('UTC__09_00__ALASKA')),
JHtml::_('select.option', -8, JText::_('UTC__08_00__PACIFIC_TIME__US__AMP__CANADA_')),
JHtml::_('select.option', -7, JText::_('UTC__07_00__MOUNTAIN_TIME__US__AMP__CANADA_')),
JHtml::_('select.option', -6, JText::_('UTC__06_00__CENTRAL_TIME__US__AMP__CANADA___MEXICO_CITY')),
JHtml::_('select.option', -5, JText::_('UTC__05_00__EASTERN_TIME__US__AMP__CANADA___BOGOTA__LIMA')),
JHtml::_('select.option', -4, JText::_('UTC__04_00__ATLANTIC_TIME__CANADA___CARACAS__LA_PAZ')),
JHtml::_('select.option', -4.5, JText::_('UTC__04_30__VENEZUELA')),
JHtml::_('select.option', -3.5, JText::_('(UTC -03:30) St. John\'s, Newfoundland, Labrador')),
JHtml::_('select.option', -3, JText::_('UTC__03_00__BRAZIL__BUENOS_AIRES__GEORGETOWN')),
JHtml::_('select.option', -2, JText::_('UTC__02_00__MID_ATLANTIC')),
JHtml::_('select.option', -1, JText::_('UTC__01_00__AZORES__CAPE_VERDE_ISLANDS')),
JHtml::_('select.option', 0, JText::_('UTC_00_00__WESTERN_EUROPE_TIME__LONDON__LISBON__CASABLANCA')),
JHtml::_('select.option', 1, JText::_('UTC__01_00__AMSTERDAM__BERLIN__BRUSSELS__COPENHAGEN__MADRID__PARIS')),
JHtml::_('select.option', 2, JText::_('UTC__02_00__ISTANBUL__JERUSALEM__KALININGRAD__SOUTH_AFRICA')),
JHtml::_('select.option', 3, JText::_('UTC__03_00__BAGHDAD__RIYADH__MOSCOW__ST__PETERSBURG')),
JHtml::_('select.option', 3.5, JText::_('UTC__03_30__TEHRAN')),
JHtml::_('select.option', 4, JText::_('UTC__04_00__ABU_DHABI__MUSCAT__BAKU__TBILISI')),
JHtml::_('select.option', 4.5, JText::_('UTC__04_30__KABUL')),
JHtml::_('select.option', 5, JText::_('UTC__05_00__EKATERINBURG__ISLAMABAD__KARACHI__TASHKENT')),
JHtml::_('select.option', 5.5, JText::_('UTC__05_30__BOMBAY__CALCUTTA__MADRAS__NEW_DELHI__COLOMBO')),
JHtml::_('select.option', 5.75, JText::_('UTC__05_45__KATHMANDU')),
JHtml::_('select.option', 6, JText::_('UTC__06_00__ALMATY__DHAKA')),
JHtml::_('select.option', 6.30, JText::_('UTC__06_30__YAGOON')),
JHtml::_('select.option', 7, JText::_('UTC__07_00__BANGKOK__HANOI__JAKARTA')),
JHtml::_('select.option', 8, JText::_('UTC__08_00__BEIJING__PERTH__SINGAPORE__HONG_KONG')),
JHtml::_('select.option', 8.75, JText::_('UTC__08_00__WESTERN_AUSTRALIA')),
JHtml::_('select.option', 9, JText::_('UTC__09_00__TOKYO__SEOUL__OSAKA__SAPPORO__YAKUTSK')),
JHtml::_('select.option', 9.5, JText::_('UTC__09_30__ADELAIDE__DARWIN__YAKUTSK')),
JHtml::_('select.option', 10, JText::_('UTC__10_00__EASTERN_AUSTRALIA__GUAM__VLADIVOSTOK')),
JHtml::_('select.option', 10.5, JText::_('UTC__10_30__LORD_HOWE_ISLAND__AUSTRALIA_')),
JHtml::_('select.option', 11, JText::_('UTC__11_00__MAGADAN__SOLOMON_ISLANDS__NEW_CALEDONIA')),
JHtml::_('select.option', 11.30, JText::_('UTC__11_30__NORFOLK_ISLAND')),
JHtml::_('select.option', 12, JText::_('UTC__12_00__AUCKLAND__WELLINGTON__FIJI__KAMCHATKA')),
JHtml::_('select.option', 12.75, JText::_('UTC__12_45__CHATHAM_ISLAND')),
JHtml::_('select.option', 13, JText::_('UTC__13_00__TONGA')),
JHtml::_('select.option', 14, JText::_('UTC__14_00__KIRIBATI')),);

return JHtml::_('select.genericlist', $timezones, $control_name.'['.$name.']',
array(
'id' => $control_name.$name,
'list.attr' => 'class="inputbox"',
'list.select' => $value
)
);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementTimezones/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementTimezones/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementTimezones
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementLanguages/fetchElement

2010-03-30T10:16:47Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementLanguages/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementLanguages/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/languages.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.languages' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$client = $node->attributes('client');

jimport('joomla.language.helper');
$languages = JLanguageHelper::createLanguageList($value, constant('JPATH_'.strtoupper($client)), true);
array_unshift($languages, JHtml::_('select.option', '', '- '.JText::_('SELECT_LANGUAGE').' -'));

return JHtml::_('select.genericlist', $languages, $control_name .'['. $name .']',
array(
'id' => $control_name.$name,
'list.attr' => 'class="inputbox"',
'list.select' => $value
)
);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementLanguages/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementLanguages/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementLanguages
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementHelpsites/fetchElement

2010-03-30T10:16:46Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementHelpsites/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementHelpsites/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/helpsites.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.helpsites' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
jimport('joomla.language.help');

$helpsites = JHelp::createSiteList(JPATH_ADMINISTRATOR.DS.'help'.DS.'helpsites-15.xml', $value);
array_unshift($helpsites, JHtml::_('select.option', '', JText::_('local')));

return JHtml::_('select.genericlist', $helpsites, $control_name .'['. $name .']',
array(
'id' => $control_name.$name,
'list.attr' => 'class="inputbox"',
'list.select' => $value
)
);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementHelpsites/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementHelpsites/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementHelpsites
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElement/fetchElement

2010-03-30T10:16:44Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElement/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElement/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$xmlElement, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$xmlElement
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$xmlElement, $control_name)
{

}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElement/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElement/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElement
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElement/fetchTooltip

2010-03-30T10:16:43Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElement/fetchTooltip|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElement/fetchTooltip}}

===Syntax===
<source lang="php">fetchTooltip($label, $description, &$xmlElement, $control_name='', $name='')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $label
|
|
|-
| $description
|
|
|-
| &$xmlElement
|
|
|-
| $control_name
| ''
|
|-
| $name
| ''
|
|}

===Defined in===
libraries/joomla/html/parameter/element.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element' );</source>

===Source Body===
<source lang="php">
public function fetchTooltip($label, $description, &$xmlElement, $control_name='', $name='')
{
$output = '<label id="'.$control_name.$name.'-lbl" for="'.$control_name.$name.'"';
if ($description) {
$output .= ' class="hasTip" title="'.JText::_($label).'::'.JText::_($description).'">';
} else {
$output .= '>';
}
$output .= JText::_($label).'</label>';

return $output;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElement/fetchTooltip|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElement/fetchTooltip}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchTooltip
category=JElement
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElement/render

2010-03-30T10:16:42Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElement/render|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElement/render}}

===Syntax===
<source lang="php">render(&$xmlElement, $value, $control_name= 'params')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$xmlElement
|
|
|-
| $value
|
|
|-
| $control_name
| 'params'
|
|}

===Defined in===
libraries/joomla/html/parameter/element.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element' );</source>

===Source Body===
<source lang="php">
public function render(&$xmlElement, $value, $control_name = 'params')
{
$name = $xmlElement->attributes('name');
$label = $xmlElement->attributes('label');
$descr = $xmlElement->attributes('description');
//make sure we have a valid label
$label = $label ? $label : $name;
$result[0] = $this->fetchTooltip($label, $descr, $xmlElement, $control_name, $name);
$result[1] = $this->fetchElement($name, $value, $xmlElement, $control_name);
$result[2] = $descr;
$result[3] = $label;
$result[4] = $value;
$result[5] = $name;

return $result;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElement/render|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElement/render}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=render
category=JElement
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JParameter/getParam

2010-03-30T10:16:36Z

Doxiki:

===Description===
Render a parameter type.


<nowiki>[</nowiki>[[Description:JParameter/getParam|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JParameter/getParam}}

===Syntax===
<source lang="php">getParam(&$node, $control_name= 'params', $group= '_default')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$node
|
| A param tag node.
|-
| $control_name
| 'params'
| The control name.
|-
| $group
| '_default'
|
|}

===Returns===
array Any array of the label, the form element and the tooltip.

===Defined in===
libraries/joomla/html/parameter.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter' );</source>

===Source Body===
<source lang="php">
public function getParam(&$node, $control_name = 'params', $group = '_default')
{
// Get the type of the parameter.
$type = $node->attributes('type');

$element = &$this->loadElement($type);

// Check for an error.
if ($element === false) {
$result = array();
$result[0] = $node->attributes('name');
$result[1] = JText::_('Element not defined for type').' = '.$type;
$result[5] = $result[0];
return $result;
}

// Get value.
$value = $this->get($node->attributes('name'), $node->attributes('default'), $group);

return $element->render($node, $value, $control_name);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JParameter/getParam|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JParameter/getParam}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=getParam
category=JParameter
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JParameter/setXML

2010-03-30T10:16:30Z

Doxiki:

===Description===
Sets the XML object from custom xml files.


<nowiki>[</nowiki>[[Description:JParameter/setXML|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JParameter/setXML}}

===Syntax===
<source lang="php">setXML(&$xml)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$xml
|
| An XML object.
|}

===Defined in===
libraries/joomla/html/parameter.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter' );</source>

===Source Body===
<source lang="php">
public function setXML(&$xml)
{
if (is_object($xml)) {
if ($group = $xml->attributes('group')) {
$this->_xml[$group] = $xml;
} else {
$this->_xml['_default'] = $xml;
}

if ($dir = $xml->attributes('addpath')) {
$this->addElementPath(JPATH_ROOT . str_replace('/', DS, $dir));
}
}
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JParameter/setXML|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JParameter/setXML}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=setXML
category=JParameter
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JHtmlGrid/checkedOut

2010-03-30T10:15:31Z

Doxiki:

<nowiki>[</nowiki>[[Description:JHtmlGrid/checkedOut|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JHtmlGrid/checkedOut}}

===Syntax===
<source lang="php">static checkedOut(&$row, $i, $identifier= 'id')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$row
|
|
|-
| $i
|
|
|-
| $identifier
| 'id'
|
|}

===Defined in===
libraries/joomla/html/html/grid.php
===Importing===
<source lang="php">jimport( 'joomla.html.html.grid' );</source>

===Source Body===
<source lang="php">
public static function checkedOut(&$row, $i, $identifier = 'id')
{
$user = &JFactory::getUser();
$userid = $user->get('id');

$result = false;
if ($row INSTANCEOF JTable) {
$result = $row->isCheckedOut($userid);
} else {
$result = JTable::isCheckedOut($userid, $row->checked_out);
}

$checked = '';
if ($result) {
$checked = JHtmlGrid::_checkedOut($row);
} else {
if ($identifier == 'id')
$checked = JHtml::_('grid.id', $i, $row->$identifier);
else
$checked = JHtml::_('grid.id', $i, $row->$identifier, $result, $identifier);
}

return $checked;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JHtmlGrid/checkedOut|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JHtmlGrid/checkedOut}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=checkedOut
category=JHtmlGrid
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JHtmlGrid/access

2010-03-30T10:15:30Z

Doxiki:

===Description===
Deprecated


<nowiki>[</nowiki>[[Description:JHtmlGrid/access|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JHtmlGrid/access}}

===Syntax===
<source lang="php">static access(&$row, $i, $archived=NULL)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$row
|
|
|-
| $i
|
|
|-
| $archived
| NULL
|
|}

===Defined in===
libraries/joomla/html/html/grid.php
===Importing===
<source lang="php">jimport( 'joomla.html.html.grid' );</source>

===Source Body===
<source lang="php">
public static function access(&$row, $i, $archived = NULL)
{
// TODO: This needs to be reworked to suit the new access levels
if ($row->access <= 1) {
$color_access = 'class="allow"';
$task_access = 'accessregistered';
} else if ($row->access == 1) {
$color_access = 'class="deny"';
$task_access = 'accessspecial';
} else {
$color_access = 'class="none"';
$task_access = 'accesspublic';
}

if ($archived == -1)
{
$href = JText::_($row->groupname);
}
else
{
$href = '
<a href="javascript:void(0);" onclick="return listItemTask(\'cb'. $i .'\',\''. $task_access .'\')" '. $color_access .'>
'. JText::_($row->groupname) .'</a>'
;
}

return $href;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JHtmlGrid/access|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JHtmlGrid/access}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=access
category=JHtmlGrid
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JFormRuleUsername/test

2010-03-30T10:15:14Z

Doxiki:

===Description===
Method to test if a username is unique.


<nowiki>[</nowiki>[[Description:JFormRuleUsername/test|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFormRuleUsername/test}}

===Syntax===
<source lang="php">test(&$field, &$values)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$field
|
| $field A reference to the form field.
|-
| &$values
|
| $values The values to test for validiaty.
|}

===Returns===
mixed on invalid rule, true if the value is valid, false otherwise.

===Defined in===
libraries/joomla/form/rules/username.php
===Importing===
<source lang="php">jimport( 'joomla.form.rules.username' );</source>

===Source Body===
<source lang="php">
public function test(&$field, &$values)
{
$return = false;
$name = (string)$field->attributes()->name;
$key = (string)$field->attributes()->field;
$value = isset($values[$key]) ? $values[$key] : 0;

// Check the rule.
if (!$key) {
return new JException('Invalid Form Rule :: '.get_class($this));
}

// Check if the username is unique.
$db = &JFactory::getDbo();
$db->setQuery(
'SELECT count(*) FROM `#__users`' .
' WHERE `username` = '.$db->Quote($values[$name]) .
' AND '.$db->nameQuote($key).' != '.$db->Quote($value)
);
$duplicate = (bool)$db->loadResult();

// Check for a database error.
if ($db->getErrorNum()) {
return new JException('Database Error :: '.$db->getErrorMsg());
}

if (!$duplicate) {
$return = true;
}

return $return;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFormRuleUsername/test|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFormRuleUsername/test}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=test
category=JFormRuleUsername
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JFormRuleEquals/test

2010-03-30T10:15:12Z

Doxiki:

===Description===
Method to test if two values are equal. To use this rule, the form XML needs a validate attribute of equals and a field attribute that is equal to the field to test against.


<nowiki>[</nowiki>[[Description:JFormRuleEquals/test|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFormRuleEquals/test}}

===Syntax===
<source lang="php">test(&$field, &$values)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$field
|
| $field A reference to the form field.
|-
| &$values
|
| $values The values to test for validiaty.
|}

===Returns===
mixed on invalid rule, true if the value is valid, false otherwise.

===Defined in===
libraries/joomla/form/rules/equals.php
===Importing===
<source lang="php">jimport( 'joomla.form.rules.equals' );</source>

===Source Body===
<source lang="php">
public function test(&$field, &$values)
{
$return = false;
$field1 = (string)$field->attributes()->name;
$field2 = (string)$field->attributes()->field;

// Check the rule.
if (!$field2) {
return new JException('Invalid Form Rule :: '.get_class($this));
}

// Test the two values against each other.
if ($values[$field1] == $values[$field2]) {
$return = true;
}

return $return;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFormRuleEquals/test|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFormRuleEquals/test}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=test
category=JFormRuleEquals
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JFormRuleEmail/test

2010-03-30T10:15:08Z

Doxiki:

===Description===
Method to test if an e-mail address is unique.


<nowiki>[</nowiki>[[Description:JFormRuleEmail/test|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFormRuleEmail/test}}

===Syntax===
<source lang="php">test(&$field, &$values)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$field
|
| $field A reference to the form field.
|-
| &$values
|
| $values The values to test for validiaty.
|}

===Returns===
mixed on invalid rule, true if the value is valid, false otherwise.

===Defined in===
libraries/joomla/form/rules/email.php
===Importing===
<source lang="php">jimport( 'joomla.form.rules.email' );</source>

===Source Body===
<source lang="php">
public function test(&$field, &$values)
{
$return = false;
$name = (string)$field->attributes()->name;
$check = ((string)$field->attributes()->unique == 'true' || (string)$field->attributes()->unique == 'unique');

// If the field is empty and not required, the field is valid.
if ((string)$field->attributes()->required != 'true') {
// Get the data for the field.
$value = array_key_exists($name, $values) ? $values[$name] : null;

// If the data is empty, return valid.
if ($value == null) {
return true;
}
}

// Check if we should test for uniqueness.
if ($check) {
$key = (string)$field->attributes()->field;
$value = isset($values[$key]) ? $values[$key] : 0;

// Check the rule.
if (!$key) {
return new JException('Invalid Form Rule :: '.get_class($this));
}

// Check if the username is unique.
$db = &JFactory::getDbo();
$db->setQuery(
'SELECT count(*) FROM `#__users`' .
' WHERE `email` = '.$db->Quote($values[$name]) .
' AND '.$db->nameQuote($key).' != '.$db->Quote($value)
);
$duplicate = (bool)$db->loadResult();

// Check for a database error.
if ($db->getErrorNum()) {
return new JException('Database Error :: '.$db->getErrorMsg());
}

// Test the value against the regular expression.
if (parent::test($field, $values) && !$duplicate) {
$return = true;
}
} else {
// Test the value against the regular expression.
if (parent::test($field, $values)) {
$return = true;
}
}

return $return;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFormRuleEmail/test|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFormRuleEmail/test}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=test
category=JFormRuleEmail
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JFormValidator/validate

2010-03-30T10:15:05Z

Doxiki:

===Description===
Method to validate a group of fields.


<nowiki>[</nowiki>[[Description:JFormValidator/validate|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFormValidator/validate}}

===Syntax===
<source lang="php">validate(&$fields, &$data)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$fields
|
| $fields An array of fields to validate.
|-
| &$data
|
| $data The data to validate.
|}

===Returns===
mixed Array on success, on error.

===Defined in===
libraries/joomla/form/formvalidator.php
===Importing===
<source lang="php">jimport( 'joomla.form.formvalidator' );</source>

===Source Body===
<source lang="php">
public function validate(&$fields, &$data)
{
$results = array();

foreach ($fields as $name => $field) {
// Get the data for the field.
$value = array_key_exists($name, $data) ? $data[$name] : null;

// Check if the field is required.
if ((string)$field->attributes()->required == 'true') {
// Check if the field value is empty.
if ($value === '') {
// The required field is empty!
if ($message = (string)$field->attributes()->message) {
$results[] = new JException(JText::_($message), 0, E_WARNING);
} else {
$results[] = new JException(JText::sprintf('Libraries_Form_Validator_Field_Required', JText::_((string)$field->attributes()->name)), 0, E_WARNING);
}

// We don't want to display more than one message per field so continue to the next one.
continue;
}
}

// Run the field validator.
$return = $this->_isValid($field, $data);

// Check for an error.
if (JError::isError($return)) {
return $return;
}

// Check if the field is valid.
if ($return === false) {
// The field failed validation.
if ($message = (string)$field->attributes()->message) {
$results[] = new JException(JText::_($message), 0, E_WARNING);
} else {
$results[] = new JException(JText::sprintf('Libraries_Form_Validator_Field_Invalid', (string)$field->attributes()->name), 0, E_WARNING);
}
}
}

return $results;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFormValidator/validate|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFormValidator/validate}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=validate
category=JFormValidator
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JFormRule/test

2010-03-30T10:15:02Z

Doxiki:

===Description===
Method to test the value.


<nowiki>[</nowiki>[[Description:JFormRule/test|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFormRule/test}}

===Syntax===
<source lang="php">test(&$field, &$values)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$field
|
| $field A reference to the form field.
|-
| &$values
|
| $values The values to test for validiaty.
|}

===Returns===
boolean True if the value is valid, false otherwise.

===Defined in===
libraries/joomla/form/formrule.php
===Importing===
<source lang="php">jimport( 'joomla.form.formrule' );</source>

===Source Body===
<source lang="php">
public function test(&$field, &$values)
{
$return = false;
$name = (string)$field->attributes()->name;

// Check for a valid regex.
if (empty($this->_regex)) {
throw new JException('Invalid Form Rule :: '.get_class($this));
}

// Add unicode property support if available.
if (JCOMPAT_UNICODE_PROPERTIES) {
$this->_modifiers = strpos($this->_modifiers, 'u') ? $this->_modifiers : $this->_modifiers.'u';
}

// Test the value against the regular expression.
if (preg_match('#'.$this->_regex.'#'.$this->_modifiers, $values[$name])) {
$return = true;
}

return $return;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFormRule/test|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFormRule/test}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=test
category=JFormRule
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JFormField/render

2010-03-30T10:15:01Z

Doxiki:

<nowiki>[</nowiki>[[Description:JFormField/render|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFormField/render}}

===Syntax===
<source lang="php">render(&$xml, $value, $formName, $groupName, $prefix)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$xml
|
|
|-
| $value
|
|
|-
| $formName
|
|
|-
| $groupName
|
|
|-
| $prefix
|
|
|}

===Defined in===
libraries/joomla/form/formfield.php
===Importing===
<source lang="php">jimport( 'joomla.form.formfield' );</source>

===Source Body===
<source lang="php">
public function render(&$xml, $value, $formName, $groupName, $prefix)
{
// Set the xml element object.
$this->_element = $xml;

// Set the id, name, and value.
$this->id = (string)$xml->attributes()->id;
$this->name = (string)$xml->attributes()->name;
$this->value = $value;

// Set the label and description text.
$this->labelText = (string)$xml->attributes()->label ? (string)$xml->attributes()->label : $this->name;
$this->descText = (string)$xml->attributes()->description;

// Set the required and validate options.
$this->required = ((string)$xml->attributes()->required == 'true' || (string)$xml->attributes()->required == 'required');
$this->validate = (string)$xml->attributes()->validate;

// Add the required class if the field is required.
if ($this->required)
{
if($xml->attributes()->class)
{
if (strpos((string)$xml->attributes()->class, 'required') === false) {
$xml->attributes()->class = $xml->attributes()->class.' required';
}
}
else
{
$xml->addAttribute('class', 'required');
}
}

// Set the field decorator.
$this->decorator = (string)$xml->attributes()->decorator;

// Set the visibility.
$this->hidden = ((string)$xml->attributes()->type == 'hidden' || (string)$xml->attributes()->hidden);

// Set the multiple values option.
$this->multiple = ((string)$xml->attributes()->multiple == 'true' || (string)$xml->attributes()->multiple == 'multiple');

// Set the form and group names.
$this->formName = $formName;
$this->groupName = $groupName;

// Set the prefix
$this->prefix = $prefix;

// Set the input name and id.
$this->inputName = $this->_getInputName($this->name, $formName, $groupName, $this->multiple);
$this->inputId = $this->_getInputId($this->id, $this->name, $formName, $groupName);

// Set the actual label and input.
$this->label = $this->_getLabel();
$this->input = $this->_getInput();

return $this;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFormField/render|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFormField/render}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=render
category=JFormField
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JForm/loadFieldsXML

2010-03-30T10:14:56Z

Doxiki:

===Description===
Loads form fields from an XML fields element optionally reseting fields before loading new ones.


<nowiki>[</nowiki>[[Description:JForm/loadFieldsXML|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JForm/loadFieldsXML}}

===Syntax===
<source lang="php">loadFieldsXML(&$xml, $reset=true, $parent=null)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$xml
|
| $xml The XML fields object.
|-
| $reset
| true
| $reset Flag to toggle whether the form groups should be reset.
|-
| $parent
| null
|
|}

===Returns===
boolean True on success, false otherwise.

===Defined in===
libraries/joomla/form/form.php
===Importing===
<source lang="php">jimport( 'joomla.form.form' );</source>

===Source Body===
<source lang="php">
public function loadFieldsXML(&$xml, $reset = true, $parent = null)
{
// Check for an XML object.
if (!is_object($xml)) {
return false;
}

// Get the group name.
$group = ((string)$xml->attributes()->group) ? (string)$xml->attributes()->group : '_default';

// Initialise the data group.
if ($reset) {
$this->_data[$group] = array();
} else {
if (!isset($this->_data[$group])) {
$this->_data[$group] = array();
}
}

if(!isset($this->_fieldsets[$group]))
{
// Get the fieldset attributes.
$this->_fieldsets[$group] = array();
}

if($parent && $value = (string) $xml->attributes()->group) {
$this->_fieldsets[$parent]['children'][] = $value;
$this->_fieldsets[$group]['parent'] = $parent;
}

// Get the fieldset label.
if ($value = (string)$xml->attributes()->label) {
$this->_fieldsets[$group]['label'] = $value;
}

// Get the fieldset description.
if ($value = (string)$xml->attributes()->description) {
$this->_fieldsets[$group]['description'] = $value;
}

// Get an optional hidden setting (at the discretion of the renderer to honour).
if ($value = (string)$xml->attributes()->hidden) {
$this->_fieldsets[$group]['hidden'] = ($value == 'true' || $value == 1) ? true : false;
}

// Get the fieldset array option.
$array = (string)$xml->attributes()->array;
if ($array=='true') {
$this->_fieldsets[$group]['array'] = true;
} elseif($array=='false' || empty($array)) {
$this->_fieldsets[$group]['array'] = false;
} else {
$this->_fieldsets[$group]['array'] = $array;
}

// Check if there is a field path to handle.
if ((string)$xml->attributes()->addfieldpath) {
jimport('joomla.filesystem.folder');
jimport('joomla.filesystem.path');
$path = JPath::clean(JPATH_ROOT.DS.$xml->attributes()->addfieldpath);

// Add the field path to the list if it exists.
if (JFolder::exists($path)) {
self::addFieldPath($path);
}
}

if ($reset) {
// Reset the field group.
$this->_groups[$group] = array();

if($xml->fields)
{
$this->loadFieldsXML($xml->fields, $reset, $group);
}

// Add the fields to the group.
foreach ($xml->field as $field) {
$this->_groups[$group][(string)$field->attributes()->name] = $field;
}
} else {
if($xml->fields)
{
$this->loadFieldsXML($xml->fields, $reset, $group);
}

// Add to the field group.
foreach ($xml->field as $field) {
$this->_groups[$group][(string)$field->attributes()->name] = $field;
}
}

return true;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JForm/loadFieldsXML|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JForm/loadFieldsXML}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=loadFieldsXML
category=JForm
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JForm/setFields

2010-03-30T10:14:50Z

Doxiki:

===Description===
Method to assign an array of fields to a group.


<nowiki>[</nowiki>[[Description:JForm/setFields|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JForm/setFields}}

===Syntax===
<source lang="php">setFields(&$fields, $group= '_default')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$fields
|
| $fields An array of field objects to assign.
|-
| $group
| '_default'
| $group The group to assign the fields to.
|}

===Returns===
void

===Defined in===
libraries/joomla/form/form.php
===Importing===
<source lang="php">jimport( 'joomla.form.form' );</source>

===Source Body===
<source lang="php">
public function setFields(&$fields, $group = '_default')
{
// Reset the fields group,
$this->_groups[$group] = array();

// Add the fields to the group.
foreach ($fields as $field) {
$this->_groups[$group][(string)$field->attributes()->name] = $field;
}
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JForm/setFields|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JForm/setFields}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=setFields
category=JForm
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JForm/setField

2010-03-30T10:14:47Z

Doxiki:

===Description===
Method to replace a field in a group.


<nowiki>[</nowiki>[[Description:JForm/setField|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JForm/setField}}

===Syntax===
<source lang="php">setField(&$field, $group= '_default')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$field
|
| $field The field object to replace.
|-
| $group
| '_default'
| $group The group to replace the field in.
|}

===Returns===
boolean True on success, false when field does not exist.

===Defined in===
libraries/joomla/form/form.php
===Importing===
<source lang="php">jimport( 'joomla.form.form' );</source>

===Source Body===
<source lang="php">
public function setField(&$field, $group = '_default')
{
$return = false;

// Add the fields to the group if it exists.
if (isset($this->_groups[$group][$field->attributes()->name])) {
$this->_groups[$group][(string)$field->attributes()->name] = $field;
$return = true;
}

return $return;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JForm/setField|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JForm/setField}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=setField
category=JForm
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JForm/addFields

2010-03-30T10:14:44Z

Doxiki:

===Description===
Method to add an array of fields to a group.


<nowiki>[</nowiki>[[Description:JForm/addFields|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JForm/addFields}}

===Syntax===
<source lang="php">addFields(&$fields, $group= '_default')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$fields
|
| $fields An array of field objects to add.
|-
| $group
| '_default'
| $group The group to add the fields to.
|}

===Returns===
void

===Defined in===
libraries/joomla/form/form.php
===Importing===
<source lang="php">jimport( 'joomla.form.form' );</source>

===Source Body===
<source lang="php">
public function addFields(&$fields, $group = '_default')
{
// Add the fields to the group.
foreach ($fields as $field) {
$this->_groups[$group][(string)$field->attributes()->name] = $field;
}
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JForm/addFields|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JForm/addFields}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=addFields
category=JForm
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JForm/addField

2010-03-30T10:14:43Z

Doxiki:

===Description===
Method to add a field to a group.


<nowiki>[</nowiki>[[Description:JForm/addField|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JForm/addField}}

===Syntax===
<source lang="php">addField(&$field, $group= '_default')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| &$field
|
| $field The field object to add.
|-
| $group
| '_default'
| $group The group to add the field to.
|}

===Returns===
void

===Defined in===
libraries/joomla/form/form.php
===Importing===
<source lang="php">jimport( 'joomla.form.form' );</source>

===Source Body===
<source lang="php">
public function addField(&$field, $group = '_default')
{
// Add the field to the group.
$this->_groups[$group][(string)$field->attributes()->name] = &$field;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JForm/addField|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JForm/addField}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=addField
category=JForm
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementTextarea/fetchElement

2010-03-30T10:14:30Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementTextarea/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementTextarea/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/textarea.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.textarea' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$rows = $node->attributes('rows');
$cols = $node->attributes('cols');
$class = ($node->attributes('class') ? 'class="'.$node->attributes('class').'"' : 'class="text_area"');
// convert tags so they are not visible when editing
$value = str_replace(' ', "\n", $value);

return '<textarea name="'.$control_name.'['.$name.']" cols="'.$cols.'" rows="'.$rows.'" '.$class.' id="'.$control_name.$name.'" >'.$value.'</textarea>';
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementTextarea/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementTextarea/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementTextarea
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementText/fetchElement

2010-03-30T10:14:27Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementText/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementText/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/text.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.text' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$size = ($node->attributes('size') ? 'size="'.$node->attributes('size').'"' : '');
$class = ($node->attributes('class') ? 'class="'.$node->attributes('class').'"' : 'class="text_area"');

// Required to avoid a cycle of encoding &
// html_entity_decode was used in place of htmlspecialchars_decode because
// htmlspecialchars_decode is not compatible with PHP 4

$value = htmlspecialchars(html_entity_decode($value, ENT_QUOTES), ENT_QUOTES, 'UTF-8');

return '<input type="text" name="'.$control_name.'['.$name.']" id="'.$control_name.$name.'" value="'.$value.'" '.$class.' '.$size.' />';
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementText/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementText/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementText
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementTemplateStyle/fetchElement

2010-03-30T10:14:25Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementTemplateStyle/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementTemplateStyle/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/templatestyle.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.templatestyle' );</source>

===Source Body===
<source lang="php">
public function fetchElement( $name, $value, &$node, $control_name )
{
$db = JFactory::getDBO();

$query = 'SELECT * FROM #__template_styles '
. 'WHERE client_id = 0 '
. 'AND home = 0';
$db->setQuery( $query );
$data = $db->loadObjectList();

$default = JHtml::_( 'select.option', 0, JText::_( 'JOPTION_USE_DEFAULT' ), 'id', 'description' );
array_unshift( $data, $default );

$selected = $this->_getSelected();
$html = JHTML::_( 'select.genericlist', $data, $control_name.'['.$name.']', 'class="inputbox" size="6"', 'id', 'description', $selected );
return $html;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementTemplateStyle/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementTemplateStyle/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementTemplateStyle
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementSQL/fetchElement

2010-03-30T10:14:24Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementSQL/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementSQL/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/sql.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.sql' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$db = & JFactory::getDbo();
$db->setQuery($node->attributes('query'));
$key = ($node->attributes('key_field') ? $node->attributes('key_field') : 'value');
$val = ($node->attributes('value_field') ? $node->attributes('value_field') : $name);

$options = $db->loadObjectlist();

// Check for an error.
if ($db->getErrorNum()) {
JError::raiseWarning(500, $db->getErrorMsg());
return false;
}

if (!$options) {
$options = array();
}

return JHtml::_('select.genericlist', $options, $control_name.'['.$name.']',
array(
'id' => $control_name.$name,
'list.attr' => 'class="inputbox"',
'list.select' => $value,
'option.key' => $key,
'option.text' => $val
)
);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementSQL/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementSQL/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementSQL
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementSpacer/fetchElement

2010-03-30T10:14:22Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementSpacer/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementSpacer/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/spacer.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.spacer' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
if ($value) {
return JText::_($value);
} else {
return ' ';
}
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementSpacer/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementSpacer/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementSpacer
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementSpacer/fetchTooltip

2010-03-30T10:14:21Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementSpacer/fetchTooltip|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementSpacer/fetchTooltip}}

===Syntax===
<source lang="php">fetchTooltip($label, $description, &$node, $control_name, $name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $label
|
|
|-
| $description
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|-
| $name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/spacer.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.spacer' );</source>

===Source Body===
<source lang="php">
public function fetchTooltip($label, $description, &$node, $control_name, $name)
{
return ' ';
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementSpacer/fetchTooltip|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementSpacer/fetchTooltip}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchTooltip
category=JElementSpacer
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementRadio/fetchElement

2010-03-30T10:14:19Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementRadio/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementRadio/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/radio.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.radio' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$options = array ();
foreach ($node->children() as $option)
{
$val = $option->attributes('value');
$text = $option->data();
$options[] = JHtml::_('select.option', $val, $text);
}

return JHtml::_('select.radiolist', $options, ''.$control_name.'['.$name.']', '', 'value', 'text', $value, $control_name.$name, true);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementRadio/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementRadio/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementRadio
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementPassword/fetchElement

2010-03-30T10:14:18Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementPassword/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementPassword/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/password.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.password' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$size = ($node->attributes('size') ? 'size="'.$node->attributes('size').'"' : '');
$class = ($node->attributes('class') ? 'class="'.$node->attributes('class').'"' : 'class="text_area"');

return '<input type="password" name="'.$control_name.'['.$name.']" id="'.$control_name.$name.'" value="'.$value.'" '.$class.' '.$size.' />';
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementPassword/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementPassword/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementPassword
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementMenuItem/fetchElement

2010-03-30T10:14:15Z

Doxiki:

<nowiki>[</nowiki>[[Description:JElementMenuItem/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementMenuItem/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
|
|-
| $value
|
|
|-
| &$node
|
|
|-
| $control_name
|
|
|}

===Defined in===
libraries/joomla/html/parameter/element/menuitem.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.menuitem' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$db = &JFactory::getDbo();

$menuType = $this->_parent->get('menu_type');
if (!empty($menuType)) {
$where = ' WHERE menutype = '.$db->Quote($menuType);
} else {
$where = ' WHERE 1';
}

// load the list of menu types
// TODO: move query to model
$query = 'SELECT menutype, title' .
' FROM #__menu_types' .
' ORDER BY title';
$db->setQuery($query);
$menuTypes = $db->loadObjectList();

if ($state = $node->attributes('state')) {
$where .= ' AND published = '.(int) $state;
}

// load the list of menu items
// TODO: move query to model
$query = 'SELECT id, parent_id, name, menutype, type' .
' FROM #__menu' .
$where .
' ORDER BY menutype, parent_id, ordering'
;

$db->setQuery($query);
$menuItems = $db->loadObjectList();

// establish the hierarchy of the menu
// TODO: use node model
$children = array();

if ($menuItems)
{
// first pass - collect children
foreach ($menuItems as $v)
{
$pt = $v->parent_id;
$list = @$children[$pt] ? $children[$pt] : array();
array_push($list, $v);
$children[$pt] = $list;
}
}

// second pass - get an indent list of the items
$list = JHtml::_('menu.treerecurse', 0, '', array(), $children, 9999, 0, 0);

// assemble into menutype groups
$n = count($list);
$groupedList = array();
foreach ($list as $k => $v) {
$groupedList[$v->menutype][] = &$list[$k];
}

// assemble menu items to the array
$options = array();
$options[] = JHtml::_('select.option', '', '- '.JText::_('SELECT_ITEM').' -');

foreach ($menuTypes as $type)
{
if ($menuType == '')
{
$options[] = JHtml::_('select.option', '0', ' ', 'value', 'text', true);
$options[] = JHtml::_('select.option', $type->menutype, $type->title . ' - ' . JText::_('Top'), 'value', 'text', true);
}
if (isset($groupedList[$type->menutype]))
{
$n = count($groupedList[$type->menutype]);
for ($i = 0; $i < $n; $i++)
{
$item = &$groupedList[$type->menutype][$i];

//If menutype is changed but item is not saved yet, use the new type in the list
if (JRequest::getString('option', '', 'get') == 'com_menus') {
$currentItemArray = JRequest::getVar('cid', array(0), '', 'array');
$currentItemId = (int) $currentItemArray[0];
$currentItemType = JRequest::getString('type', $item->type, 'get');
if ($currentItemId == $item->id && $currentItemType != $item->type) {
$item->type = $currentItemType;
}
}

$disable = strpos($node->attributes('disable'), $item->type) !== false ? true : false;
$options[] = JHtml::_('select.option', $item->id, '   ' .$item->treename, 'value', 'text', $disable);

}
}
}

return JHtml::_('select.genericlist', $options, $control_name.'['.$name.']',
array(
'id' => $control_name.$name,
'list.attr' => 'class="inputbox"',
'list.select' => $value
)
);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementMenuItem/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementMenuItem/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementMenuItem
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API16:JElementList/fetchElement

2010-03-30T10:14:10Z

Doxiki:

===Description===
Fetch the HTML code for the parameter element.


<nowiki>[</nowiki>[[Description:JElementList/fetchElement|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JElementList/fetchElement}}

===Syntax===
<source lang="php">fetchElement($name, $value, &$node, $control_name)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
| The field name.
|-
| $value
|
| The value of the field.
|-
| &$node
|
| The current XML node.
|-
| $control_name
|
| The name of the HTML control.
|}

===Defined in===
libraries/joomla/html/parameter/element/list.php
===Importing===
<source lang="php">jimport( 'joomla.html.parameter.element.list' );</source>

===Source Body===
<source lang="php">
public function fetchElement($name, $value, &$node, $control_name)
{
$ctrl = $control_name .'['. $name .']';
$attribs = ' ';

if ($v = $node->attributes('size')) {
$attribs .= 'size="'.$v.'"';
}
if ($v = $node->attributes('class')) {
$attribs .= 'class="'.$v.'"';
} else {
$attribs .= 'class="inputbox"';
}
if ($m = $node->attributes('multiple'))
{
$attribs .= 'multiple="multiple"';
$ctrl .= '[]';
}

return JHtml::_(
'select.genericlist',
$this->_getOptions($node),
$ctrl,
array(
'id' => $control_name.$name,
'list.attr' => $attribs,
'list.select' => $value
)
);
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JElementList/fetchElement|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JElementList/fetchElement}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=fetchElement
category=JElementList
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>