| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved. |
| License: | GNU/GPL, see LICENSE.php |
| Version: | $Id: parameter.php 14401 2010-01-26 14:10:00Z louis $ |
| File Size: | 454 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
JParameter:: (15 methods):
__construct()
set()
get()
def()
setXML()
bind()
render()
renderToArray()
getNumParams()
getGroups()
getParams()
getParam()
loadSetupFile()
loadElement()
addElementPath()
Class: JParameter - X-Ref
Parameter handler| __construct($data, $path = '') X-Ref |
| Constructor param: string The raw parms text param: string Path to the xml setup file |
| set($key, $value = '', $group = '_default') X-Ref |
| Set a value param: string The name of the param param: string The value of the parameter return: string The set value |
| get($key, $default = '', $group = '_default') X-Ref |
| Get a value param: string The name of the param param: mixed The default value if not found return: string |
| def($key, $default = '', $group = '_default') X-Ref |
| Sets a default value if not alreay assigned param: string The name of the param param: string The value of the parameter param: string The parameter group to modify return: string The set value |
| setXML( &$xml ) X-Ref |
| Sets the XML object from custom xml files param: object An XML object |
| bind($data, $group = '_default') X-Ref |
| Bind data to the parameter param: mixed $data Array or Object return: boolean True if the data was successfully bound |
| render($name = 'params', $group = '_default') X-Ref |
| Render param: string The name of the control, or the default text area if a setup file is not found return: string HTML |
| renderToArray($name = 'params', $group = '_default') X-Ref |
| Render all parameters to an array param: string The name of the control, or the default text area if a setup file is not found return: array Array of all parameters, each as array Any array of the label, the form element and the tooltip |
| getNumParams($group = '_default') X-Ref |
| Return number of params to render return: mixed Boolean falst if no params exist or integer number of params that exist |
| getGroups() X-Ref |
| Get the number of params in each group return: array Array of all group names as key and param count as value |
| getParams($name = 'params', $group = '_default') X-Ref |
| Render all parameters param: string The name of the control, or the default text area if a setup file is not found return: array Aarray of all parameters, each as array Any array of the label, the form element and the tooltip |
| getParam(&$node, $control_name = 'params', $group = '_default') X-Ref |
| Render a parameter type param: object A param tag node param: string The control name return: array Any array of the label, the form element and the tooltip |
| loadSetupFile($path) X-Ref |
| Loads an xml setup file and parses it param: string path to xml setup file return: object |
| loadElement( $type, $new = false ) X-Ref |
| Loads a element type param: string elementType return: object |
| addElementPath( $path ) X-Ref |
| 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: string|array directory or directories to search. |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |