Référence de la classe JParameter

Graphe d'héritage de JParameter:

Graphe de collaboration de JParameter:

Liste de tous les membres

Fonctions membres publiques

• __construct ($data, $path= '')
• set ($key, $value= '', $group= '_default')
• get ($key, $default= '', $group= '_default')
• def ($key, $default= '', $group= '_default')
• setXML (&$xml)
• bind ($data, $group= '_default')
• render ($name= 'params', $group= '_default')
• renderToArray ($name= 'params', $group= '_default')
• getNumParams ($group= '_default')
• getGroups ()
• getParams ($name= 'params', $group= '_default')
• getParam (&$node, $control_name= 'params', $group= '_default')
• loadSetupFile ($path)
• & loadElement ($type, $new=false)
• addElementPath ($path)

Attributs publics

• $_raw = null
• $_xml = null
• $_elements = array()
• $_elementPath = array()

---

Documentation des constructeurs et destructeur

JParameter::__construct	(	$	data,
		$	path = ''
	)

Constructor

protected

Paramètres:

string	The raw parms text
string	Path to the xml setup file

Depuis:

1.5

Références $data, et $path.

---

Documentation des fonctions membres

JParameter::addElementPath

(

$

path

)

Add a directory where JParameter should search for element types

You may either pass a string or an array of directories.

JParameter will be searching for a element type in the same order you added them. If the parameter type cannot be found in the custom folders, it will look in JParameter/types.

public

Paramètres:

string|array

directory or directories to search.

Depuis:

1.5

Références $path.

JParameter::bind	(	$	data,
		$	group = '_default'
	)

Bind data to the parameter

Paramètres:

mixed

$data

Array or Object

Renvoie:

boolean True if the data was successfully bound public

Depuis:

1.5

Références $data, et elseif.

JParameter::def	(	$	key,
		$	default = '',
		$	group = '_default'
	)

Sets a default value if not alreay assigned

public

Paramètres:

string	The name of the param
string	The value of the parameter
string	The parameter group to modify

Renvoie:

string The set value

Depuis:

1.5

JParameter::get	(	$	key,
		$	default = '',
		$	group = '_default'
	)

Get a value

public

Paramètres:

string	The name of the param
mixed	The default value if not found

Renvoie:

string

Depuis:

1.5

JParameter::getGroups

(

)

Get the number of params in each group

public

Renvoie:

array Array of all group names as key and param count as value

Depuis:

1.5

Références $name.

JParameter::getNumParams

(

$

group = '_default'

)

Return number of params to render

public

Renvoie:

mixed Boolean falst if no params exist or integer number of params that exist

Depuis:

1.5

JParameter::getParam	(	&$	node,
		$	control_name = 'params',
		$	group = '_default'
	)

Render a parameter type

Paramètres:

object	A param tag node
string	The control name

Renvoie:

array Any array of the label, the form element and the tooltip

Depuis:

1.5

Références $type, et JText::_().

Voici le graphe d'appel pour cette fonction :

JParameter::getParams	(	$	name = 'params',
		$	group = '_default'
	)

Render all parameters

public

Paramètres:

string

The name of the control, or the default text area if a setup file is not found

Renvoie:

array Aarray of all parameters, each as array Any array of the label, the form element and the tooltip

Depuis:

1.5

Références $name.

& JParameter::loadElement	(	$	type,
		$	new = false
	)

Loads a element type

public

Paramètres:

string

elementType

Renvoie:

object

Depuis:

1.5

Références $file, $type, JFilterInput::clean(), JPath::find(), et jimport().

Voici le graphe d'appel pour cette fonction :

JParameter::loadSetupFile

(

$

path

)

Loads an xml setup file and parses it

public

Paramètres:

string

path to xml setup file

Renvoie:

object

Depuis:

1.5

Références $params, $path, et JFactory::getXMLParser().

Voici le graphe d'appel pour cette fonction :

JParameter::render	(	$	name = 'params',
		$	group = '_default'
	)

Render

public

Paramètres:

string

The name of the control, or the default text area if a setup file is not found

Renvoie:

string HTML

Depuis:

1.5

Références $desc, $name, $params, et JText::_().

Voici le graphe d'appel pour cette fonction :

JParameter::renderToArray	(	$	name = 'params',
		$	group = '_default'
	)

Render all parameters to an array

public

Paramètres:

string

The name of the control, or the default text area if a setup file is not found

Renvoie:

array Array of all parameters, each as array Any array of the label, the form element and the tooltip

Depuis:

1.5

Références $name.

JParameter::set	(	$	key,
		$	value = '',
		$	group = '_default'
	)

Set a value

public

Paramètres:

string	The name of the param
string	The value of the parameter

Renvoie:

string The set value

Depuis:

1.5

JParameter::setXML

(

&$

xml

)

Sets the XML object from custom xml files

public

Paramètres:

object

An XML object

Depuis:

1.5

---

Documentation des données membres

JParameter::$_elementPath = array()

JParameter::$_elements = array()

JParameter::$_raw = null

JParameter::$_xml = null

---

La documentation de cette classe a été générée à partir du fichier suivant :

• parameter.php