Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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= '')
 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)
- Fonctions membres publiques inherited from JRegistry
 __construct ($data=null)
 __clone ()
 __toString ()
 def ($key, $default= '')
 exists ($path)
 get ($path, $default=null)
 loadArray ($array)
 loadObject ($object)
 loadFile ($file, $format= 'JSON', $options=array())
 loadString ($data, $format= 'JSON', $options=array())
 merge (&$source)
 set ($path, $value)
 toArray ()
 toObject ()
 toString ($format= 'JSON', $options=array())
 loadXML ($data, $namespace=null)
 loadINI ($data, $namespace=null, $options=array())
 loadJSON ($data)
 makeNameSpace ($namespace)
 getNameSpaces ()
 getValue ($path, $default=null)
 setValue ($path, $value)
 loadSetupFile ()

Attributs protégés

 $_raw = null
 $_xml = null
 $_elements = array()
 $_elementPath = array()
- Attributs protégés inherited from JRegistry
 $data

Additional Inherited Members

- Fonctions membres publiques statiques inherited from JRegistry
static getInstance ($id)
- Fonctions membres protégées inherited from JRegistry
 bindData (&$parent, $data)
 asArray ($data)
- Attributs protégés statiques inherited from JRegistry
static $instances = array()

Documentation des constructeurs et destructeur

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

Constructor

Paramètres:
string$dataThe raw parms text.
string$pathPath to the XML setup file.
Obsolète:
12.1
Depuis:
11.1

Références $data, $path, JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :


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.

Paramètres:
mixed$pathDirectory (string) or directories (array) to search.
Renvoie:
void
Obsolète:
12.1
Depuis:
11.1

Références $path, et DIRECTORY_SEPARATOR.

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

Bind data to the parameter.

Paramètres:
mixed$dataAn array or object.
string$groupAn optional group that the data should bind to. The default group is used if not supplied.
Renvoie:
boolean True if the data was successfully bound, false otherwise.
Obsolète:
12.1
Depuis:
11.1

Références $data, JLog\add(), elseif, et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

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

Sets a default value if not alreay assigned.

Paramètres:
string$keyThe name of the parameter.
string$defaultAn optional value for the parameter.
string$groupAn optional group for the parameter.
Renvoie:
string The value set, or the default if the value was not previously set (or null).
Obsolète:
12.1
Depuis:
11.1

Références $key, JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JParameter::getGroups ( )

Get the number of params in each group.

Renvoie:
array Array of all group names as key and parameters count as value.
Obsolète:
12.1
Depuis:
11.1

Références $name, JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JParameter::getNumParams (   $group = '_default')

Return the number of parameters in a group.

Paramètres:
string$groupAn optional group. The default group is used if not supplied.
Renvoie:
mixed False if no params exist or integer number of parameters that exist.
Obsolète:
12.1
Depuis:
11.1

Références JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

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

Render a parameter type.

Paramètres:
object&$nodeA parameter XML element.
string$control_nameAn optional name of the HTML form control. The default is 'params' if not supplied.
string$groupAn optional group to render. The default group is used if not supplied.
Renvoie:
array Any array of the label, the form element and the tooltip.
Obsolète:
12.1
Depuis:
11.1

Références $type, JText\_(), JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

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

Render all parameters.

Paramètres:
string$nameAn optional name of the HTML form control. The default is 'params' if not supplied.
string$groupAn optional group to render. The default group is used if not supplied.
Renvoie:
array An array of all parameters, each as array of the label, the form element and the tooltip.
Obsolète:
12.1
Depuis:
11.1

Références $name, JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

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

Loads an element type.

Paramètres:
string$typeThe element type.
boolean$newFalse (default) to reuse parameter elements; true to load the parameter element type again.
Renvoie:
object
Obsolète:
12.1
Depuis:
11.1

Références $file, $type, DS, JPath\find(), JFilterInput\getInstance(), et jimport().

+ Voici le graphe d'appel pour cette fonction :

JParameter::loadSetupFile (   $path)

Loads an XML setup file and parses it.

Paramètres:
string$pathA path to the XML setup file.
Renvoie:
object
Obsolète:
12.1
Depuis:
11.1

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

+ Voici le graphe d'appel pour cette fonction :

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

Render the form control.

Paramètres:
string$nameAn optional name of the HTML form control. The default is 'params' if not supplied.
string$groupAn optional group to render. The default group is used if not supplied.
Renvoie:
string HTML
Obsolète:
12.1
Depuis:
11.1

Références $desc, $html, $name, $params, JText\_(), JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

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

Render all parameters to an array.

Paramètres:
string$nameAn optional name of the HTML form control. The default is 'params' if not supplied.
string$groupAn optional group to render. The default group is used if not supplied.
Renvoie:
array
Obsolète:
12.1
Depuis:
11.1

Références $name, JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JParameter::setXML ( $xml)

Sets the XML object from custom XML files.

Paramètres:
JSimpleXMLElement&$xmlAn XML object.
Renvoie:
void
Obsolète:
12.1
Depuis:
11.1

Références JLog\add(), DS, JPATH_ROOT, et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JParameter::$_elementPath = array()
protected
JParameter::$_elements = array()
protected
JParameter::$_raw = null
protected
JParameter::$_xml = null
protected

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