[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Installer/ -> InstallerAdapter.php (summary)

Joomla! Content Management System

Copyright: (C) 2014 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 1284 lines (38 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 27 functions

  __construct()
  canUninstallPackageChild()
  checkExistingExtension()
  checkExtensionInFilesystem()
  createExtensionRoot()
  discover_install()
  doDatabaseTransactions()
  doLoadLanguage()
  getDiscoverInstallSupported()
  getElement()
  getManifest()
  getName()
  getParent()
  getRoute()
  getScriptClassName()
  install()
  parseQueries()
  parseOptionalTags()
  prepareDiscoverInstall()
  setManifest()
  setRoute()
  setupScriptfile()
  setupUpdates()
  triggerManifestScript()
  uninstall()
  update()
  __get()

Functions
Functions that are not part of a class:

__construct(Installer $parent, DatabaseDriver $db, array $options = array()   X-Ref
Constructor

param: Installer       $parent   Parent object
param: DatabaseDriver  $db       Database object
param: array           $options  Configuration Options

canUninstallPackageChild($packageId)   X-Ref
Check if a package extension allows its child extensions to be uninstalled individually

param: integer  $packageId  The extension ID of the package to check
return: boolean

checkExistingExtension()   X-Ref
Method to check if the extension is already present in the database

return: void

checkExtensionInFilesystem()   X-Ref
Method to check if the extension is present in the filesystem, flags the route as update if so

return: void

createExtensionRoot()   X-Ref
Method to create the extension root path if necessary

return: void

discover_install()   X-Ref
Generic discover_install method for extensions

return: boolean  True on success

doDatabaseTransactions()   X-Ref
Method to handle database transactions for the installer

return: boolean  True on success

doLoadLanguage($extension, $source, $base = JPATH_ADMINISTRATOR)   X-Ref
Load language files

param: string  $extension  The name of the extension
param: string  $source     Path to the extension
param: string  $base       Base path for the extension language
return: void

getDiscoverInstallSupported()   X-Ref
Checks if the adapter supports discover_install

return: boolean

getElement($element = null)   X-Ref
Get the filtered extension element from the manifest

param: string  $element  Optional element name to be converted
return: string  The filtered element

getManifest()   X-Ref
Get the manifest object.

return: \SimpleXMLElement  Manifest object

getName()   X-Ref
Get the filtered component name from the manifest

return: string  The filtered name

getParent()   X-Ref
Retrieves the parent installer

return: Installer

getRoute()   X-Ref
Get the install route being followed

return: string  The install route

getScriptClassName()   X-Ref
Get the class name for the install adapter script.

return: string  The class name.

install()   X-Ref
Generic install method for extensions

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

parseQueries()   X-Ref
Method to parse the queries specified in the `<sql>` tags

return: void

parseOptionalTags()   X-Ref
Method to parse optional tags in the manifest

return: void

prepareDiscoverInstall()   X-Ref
Prepares the adapter for a discover_install task

return: void

setManifest($manifest)   X-Ref
Set the manifest object.

param: object  $manifest  The manifest object
return: InstallerAdapter  Instance of this class to support chaining

setRoute($route)   X-Ref
Set the install route being followed

param: string  $route  The install route being followed
return: InstallerAdapter  Instance of this class to support chaining

setupScriptfile()   X-Ref
Setup the manifest script file for those adapters that use it.

return: void

setupUpdates()   X-Ref
No description

triggerManifestScript($method)   X-Ref
Executes a custom install script method

param: string  $method  The install method to execute
return: boolean  True on success

uninstall($id)   X-Ref
Generic update method for extensions

param: integer  $id  The extension ID
return: boolean  True on success

update()   X-Ref
Generic update method for extensions

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

__get($name)   X-Ref
Proxy for db variable.

param: string  $name  The name of the element
return: mixed  The value of the element if set, null otherwise



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer