JInstallerTemplate

Extends \JAdapterInstance

Template installer

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

package

Joomla.Platform

subpackage

Installer

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.

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

discover

Discover existing but uninstalled templates

discover() : array

Response

arrayJExtensionTable list

discover_install

Discover_install Perform an install for a discovered extension

discover_install() : boolean
since

11.1

Response

boolean

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.

getParent

Retrieves the parent object

getParent() : object
inherited
since

11.1

Response

objectparent

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

install

Custom install method

install() : boolean
since

11.1

Response

booleanTrue on success

loadLanguage

Custom loadLanguage method

loadLanguage(string $path = null) : \JInstallerTemplate
since

11.1

Arguments

$path

stringThe path where to find language files.

Response

\JInstallerTemplate

refreshManifestCache

Refreshes the extension table cache

refreshManifestCache() : boolean
since

11.1

Response

booleanResult of operation, true if updated, false on failure

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

uninstall

Custom uninstall method

uninstall(integer $id) : boolean
since

11.1

Arguments

$id

integerThe extension ID

Response

booleanTrue on success

update

Custom update method for components

update() : boolean
since

11.1

Response

booleanTrue on success

Properties

name

Type(s)

element

Type(s)

route

Type(s)

parent

Parent

inherited
since

11.1

Type(s)

\JInstaller

db

Database

inherited
since

11.1

Type(s)

\JDatabase

_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