\JInstaller

Joomla base installer class

Synopsis

class JInstaller extends JAdapter {

• // members
• protected  $paths;
• protected  $upgrade;
• public   $manifestClass;
• protected  $overwrite;
• protected  $stepStack;
• public JTableExtension  $extension;
• public  $message;
• public   $manifest;
• protected  $extension_message;
• protected  $redirect_url;
• protected JInstaller  $instance;
• // Inherited members from JAdapter
• protected  $_adapters;
• protected  $_adapterfolder;
• protected  $_classprefix;
• protected  $_basepath;
• protected JDatabaseDriver  $_db;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• public void __construct()
• public static JInstaller getInstance()
• public boolean isOverwrite()
• public boolean setOverwrite()
• public string getRedirectURL()
• public void setRedirectURL()
• public boolean isUpgrade()
• public boolean setUpgrade()
• public  getManifest()
• public string getPath()
• public void setPath()
• public void pushStep()
• public boolean abort()
• public boolean install()
• public boolean discover_install()
• public array discover()
• public boolean update()
• public boolean uninstall()
• public mixed refreshManifestCache()
• public boolean setupInstall()
• public mixed parseQueries()
• public mixed parseSQLFiles()
• public void setSchemaVersion()
• public boolean parseSchemaUpdates()
• public boolean parseFiles()
• public boolean parseLanguages()
• public boolean parseMedia()
• public string getParams()
• public boolean copyFiles()
• public boolean removeFiles()
• public boolean copyManifest()
• public boolean findManifest()
• public mixed isManifest()
• public string generateManifestCache()
• public  cleanDiscoveredExtension()
• public array findDeletedFiles()
• public array loadMD5Sum()
• public static array parseXMLInstallFile()
• // Inherited methods from JAdapter
• public void __construct()
• public JDatabaseDriver getDBO()
• public boolean setAdapter()
• public  getAdapter()
• public void loadAllAdapters()
• // Inherited methods from JObject
• public void __construct()
• public string __toString()
• public mixed def()
• public mixed get()
• public array getProperties()
• public string getError()
• public array getErrors()
• public mixed set()
• public boolean setProperties()
• public void setError()
}


Hierarchy

Extends

• JAdapter

Tasks

Tasks

Line	Task
1310	work out why the below line triggers 'node no longer exists' errors with files

Members

protected

• $_adapterfolder — string
  Adapter Folder
• $_adapters — array
  Associative array of adapters
• $_basepath — string
  Base Path for the adapter instance
• $_classprefix — string
• $_db — JDatabaseDriver
  Database Connector Object
• $_errors — array
  An array of error messages or Exception objects.
• $extension_message — string
  The extension message that appears
• $instance — JInstaller
  JInstaller instance container.
• $overwrite — boolean
  True if existing files can be overwritten
• $paths — array
  Array of paths needed by the installer
• $redirect_url — string
  The redirect URL if this extension (can be null if no redirect)
• $stepStack — array
  Stack of installation steps - Used for installation rollback
• $upgrade — boolean
  True if package is an upgrade

public

• $extension — JTableExtension
  Extension Table Entry
• $manifest —
  The installation manifest XML object
• $manifestClass —
  The manifest trigger class
• $message — string
  The output from the install/uninstall scripts

Methods

public

• __construct() — Constructor
• abort() — Installation abort method
• cleanDiscoveredExtension() — Cleans up discovered extensions if they're being installed some other way
• copyFiles() — Copyfiles
• copyManifest() — Copies the installation manifest file to the extension folder in the given client
• discover() — Extension discover method Asks each adapter to find extensions
• discover_install() — Discovered package installation method
• findDeletedFiles() — Compares two "files" entries to find deleted files/folders
• findManifest() — Tries to find the package manifest file
• generateManifestCache() — Generates a manifest cache
• getInstance() — Returns the global Installer object, only creating it if it doesn't already exist.
• getManifest() — Get the installation manifest object
• getParams() — Method to parse the parameters of an extension, build the INI string for its default parameters, and return the INI string.
• getPath() — Get an installer path by name
• getRedirectURL() — Get the redirect location
• install() — Package installation method
• isManifest() — Is the XML file a valid Joomla installation manifest file.
• isOverwrite() — Get the allow overwrite switch
• isUpgrade() — Get the upgrade switch
• loadMD5Sum() — Loads an MD5SUMS file into an associative array
• parseFiles() — Method to parse through a files element of the installation manifest and take appropriate action.
• parseLanguages() — Method to parse through a languages element of the installation manifest and take appropriate action.
• parseMedia() — Method to parse through a media element of the installation manifest and take appropriate action.
• parseQueries() — Backward compatible method to parse through a queries element of the installation manifest file and take appropriate action.
• parseSQLFiles() — Method to extract the name of a discreet installation sql file from the installation manifest file.
• parseSchemaUpdates() — Method to process the updates for an item
• parseXMLInstallFile() — Parse a XML install manifest file.
• pushStep() — Pushes a step onto the installer stack for rolling back steps
• refreshManifestCache() — Refreshes the manifest cache stored in #__extensions
• removeFiles() — Method to parse through a files element of the installation manifest and remove the files that were installed
• setOverwrite() — Set the allow overwrite switch
• setPath() — Sets an installer path by name
• setRedirectURL() — Set the redirect location
• setSchemaVersion() — Set the schema version for an extension by looking at its latest update
• setUpgrade() — Set the upgrade switch
• setupInstall() — Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.
• uninstall() — Package uninstallation method
• update() — Package update method

Inherited from JAdapter

public

• getAdapter() — Return an adapter.
• getDBO() — Get the database connector object
• loadAllAdapters() — Loads all adapters.
• setAdapter() — Set an adapter by name

Inherited from JObject

public

• __toString() — Magic method to convert the object to a string gracefully.
• def() — Sets a default value if not alreay assigned
• get() — Returns a property of the object or the default value if the property is not set.
• getError() — Get the most recent error message.
• getErrors() — Return all errors, if any.
• getProperties() — Returns an associative array of object properties.
• set() — Modifies a property of the object, creating it if it does not already exist.
• setError() — Add an error message.
• setProperties() — Set the object properties based on a named array/hash.