1. class
  2. Joomla
  3. CMS
  4. Installer
  5. Adapter
  6. ModuleAdapter

ModuleAdapter

class ModuleAdapter extends InstallerAdapter

Module installer

Properties

string $manifest Copy of the XML manifest file. from InstallerAdapter

Methods

__construct( JAdapter $parent, JDatabaseDriver $db, array $options = array())

Constructor

from InstallerAdapter
Installer
getParent()

Retrieves the parent object.

from InstallerAdapter
boolean
discover_install()

Generic discover_install method for extensions

from InstallerAdapter
boolean
getDiscoverInstallSupported()

Checks if the adapter supports discover_install

from InstallerAdapter
string
getElement( string $element = null)

Get the filtered extension element from the manifest

SimpleXMLElement
getManifest()

Get the manifest object.

from InstallerAdapter
string
getName()

Get the filtered component name from the manifest

from InstallerAdapter
string
getRoute()

Get the install route being followed

from InstallerAdapter
boolean|integer
install()

Generic install method for extensions

from InstallerAdapter
void
prepareDiscoverInstall()

Prepares the adapter for a discover_install task

InstallerAdapter
setManifest( object $manifest)

Set the manifest object.

from InstallerAdapter
InstallerAdapter
setRoute( string $route)

Set the install route being followed

from InstallerAdapter
boolean|integer
update()

Generic update method for extensions

from InstallerAdapter
void
loadLanguage( string $path = null)

Custom loadLanguage method

array
discover()

Custom discover method

boolean
refreshManifestCache()

Refreshes the extension table cache

boolean
uninstall( integer $id)

Custom uninstall method

Details

__construct( JAdapter $parent, JDatabaseDriver $db, array $options = array())

Constructor

Parameters

JAdapter $parent Parent object
JDatabaseDriver $db Database object
array $options Configuration Options

Installer getParent()

Retrieves the parent object.

Return Value

Installer

boolean discover_install()

Generic discover_install method for extensions

Return Value

boolean True on success

boolean getDiscoverInstallSupported()

Checks if the adapter supports discover_install

Return Value

boolean

string getElement( string $element = null)

Get the filtered extension element from the manifest

Parameters

string $element Optional element name to be converted

Return Value

string The filtered element

SimpleXMLElement getManifest()

Get the manifest object.

Return Value

SimpleXMLElement Manifest object

string getName()

Get the filtered component name from the manifest

Return Value

string The filtered name

string getRoute()

Get the install route being followed

Return Value

string The install route

boolean|integer install()

Generic install method for extensions

Return Value

boolean|integer The extension ID on success, boolean false on failure

void prepareDiscoverInstall()

Prepares the adapter for a discover_install task

Return Value

void

InstallerAdapter setManifest( object $manifest)

Set the manifest object.

Parameters

object $manifest The manifest object

Return Value

InstallerAdapter Instance of this class to support chaining

InstallerAdapter setRoute( string $route)

Set the install route being followed

Parameters

string $route The install route being followed

Return Value

InstallerAdapter Instance of this class to support chaining

boolean|integer update()

Generic update method for extensions

Return Value

boolean|integer The extension ID on success, boolean false on failure

void loadLanguage( string $path = null)

Custom loadLanguage method

Parameters

string $path The path where we find language files

Return Value

void

array discover()

Custom discover method

Return Value

array Extension list of extensions available

boolean refreshManifestCache()

Refreshes the extension table cache

Return Value

boolean Result of operation, true if updated, false on failure.

boolean uninstall( integer $id)

Custom uninstall method

Parameters

integer $id The id of the module to uninstall

Return Value

boolean True on success