JElementHelpsites

Extends \JElement

Renders a helpsites element

deprecated

The JElement is the base class for all JElement types

package

Joomla.Platform

subpackage

Parameter

since

11.1

deprecated

Use JFormFieldHelpsite instead

note

When updating note that JformFieldHelpsite does not end in s.

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1

deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

fetchElement

Fetch an element

fetchElement(string $name, string $value,  &$xmlElement, string $control_name) : void
inherited deprecated
deprecated

12.1

since

11.1

Arguments

$name

stringName attribute of the element

$value

stringValue attribute of the element

$xmlElement

$control_name

stringControl name of the element

fetchTooltip

Method to get a tool tip from an XML element

fetchTooltip(string $label, string $description,  &$xmlElement, string $control_name = '', string $name = '') : string
inherited deprecated
deprecated

12.1

since

11.1

Arguments

$label

stringLabel attribute for the element

$description

stringDescription attribute for the element

$xmlElement

$control_name

stringControl name

$name

stringName attribut

Response

string

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
since

11.1

see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getName

Get the element name

getName() : string
inherited deprecated
since

11.1

deprecated

12.1

Response

stringtype of the parameter

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1

see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

render

Method to render an xml element

render( &$xmlElement, string $value, string $control_name = 'params') : array
inherited deprecated
deprecated

12.1

since

11.1

Arguments

$xmlElement

$value

stringValue of the element

$control_name

stringName of the control

Response

arrayAttributes of an element

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

11.1

see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

toString

Converts the object to a string (the class name).

toString() : string
inherited deprecated
since

11.1

deprecated

12.1 Use magic method __toString()

see \JObject::__toString()

Response

string

Properties

_name

Element name

inherited

This has to be set in the final renderer classes.

since

11.1

Type(s)

string

_parent

Reference to the object that instantiated the element

inherited
since

11.1

Type(s)

object

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array