Joomla! API

Download
Launch

JUpdate

Extends \JObject

Update class.

This class allows for simple but smart objects with get and set methods and an internal error handler.

package

Joomla.Platform
subpackage

Updater
since

11.1

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.

_characterData

Character Parser Function

_characterData(object $parser, object $data) : void
note

This is public because its called externally.
since

11.1

Arguments

$parser

objectParser object.

$data

objectThe data.

_endElement

Callback for closing the element

_endElement(object $parser, string $name) : void
note

This is public because it is called externally
since

11.1

Arguments

$parser

objectParser object

$name

stringName of element that was closed

_getLastTag

Get the last position in stack count

_getLastTag() : string
since

11.1

Response

string

_getStackLocation

Gets the reference to the current direct parent

_getStackLocation() : object
since

11.1

Response

object

_startElement

XML Start Element callback

_startElement(object $parser, string $name, array $attrs = array()) : void
note

This is public because it is called externally
since

11.1

Arguments

$parser

objectParser object

$name

stringName of the tag found

$attrs

arrayAttributes of the tag

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

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.

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

loadFromXML

Loads an XML file from a URL.

loadFromXML(string $url) : boolean
since

11.1

Arguments

$url

stringThe URL.

Response

booleanTrue on success

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

since

11.1

Type(s)

string

description

since

11.1

Type(s)

string

element

since

11.1

Type(s)

string

type

since

11.1

Type(s)

string

version

since

11.1

Type(s)

string

infourl

since

11.1

Type(s)

string

client

since

11.1

Type(s)

string

group

since

11.1

Type(s)

string

downloads

since

11.1

Type(s)

string

tags

since

11.1

Type(s)

string

maintainer

since

11.1

Type(s)

string

maintainerurl

since

11.1

Type(s)

string

category

since

11.1

Type(s)

string

relationships

since

11.1

Type(s)

string

targetplatform

since

11.1

Type(s)

string

_xml_parser

since

11.1

Type(s)

string

_stack

since

11.1

Type(s)

array

_state_store

since

11.1

Type(s)

array

_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
  • \ \
  • \ JUpdate