| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2005 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1460 lines (53 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ComponentAdapter:: (23 methods):
checkExtensionInFilesystem()
copyBaseFiles()
createExtensionRoot()
finaliseInstall()
finaliseUninstall()
getElement()
loadLanguage()
parseOptionalTags()
parseQueries()
prepareDiscoverInstall()
removeExtensionFiles()
setupInstallPaths()
setupUninstall()
setupUpdates()
storeExtension()
_buildAdminMenus()
_removeAdminMenus()
_updateSiteMenus()
_updateMenus()
_rollback_menu()
discover()
refreshManifestCache()
_createAdminMenuItem()
Class: ComponentAdapter - X-Ref
Component installer| checkExtensionInFilesystem() X-Ref |
| Method to check if the extension is present in the filesystem return: boolean |
| copyBaseFiles() X-Ref |
| Method to copy the extension's base files from the `<files>` tag(s) and the manifest file return: void |
| createExtensionRoot() X-Ref |
| Method to create the extension root path if necessary return: void |
| finaliseInstall() X-Ref |
| Method to finalise the installation processing return: void |
| finaliseUninstall() X-Ref |
| Method to finalise the uninstallation processing 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 |
| loadLanguage($path = null) X-Ref |
| Custom loadLanguage method param: string $path The path language files are on. return: void |
| parseOptionalTags() X-Ref |
| Method to parse optional tags in the manifest return: void |
| parseQueries() X-Ref |
| Method to parse the queries specified in the `<sql>` tags return: void |
| prepareDiscoverInstall() X-Ref |
| Prepares the adapter for a discover_install task return: void |
| removeExtensionFiles() X-Ref |
| Removes this extension's files return: void |
| setupInstallPaths() X-Ref |
| Method to do any prechecks and setup the install paths for the extension return: void |
| setupUninstall() X-Ref |
| Method to do any prechecks and setup the uninstall job return: void |
| setupUpdates() X-Ref |
| Method to setup the update routine for the adapter return: void |
| storeExtension($deleteExisting = false) X-Ref |
| Method to store the extension to the database param: bool $deleteExisting Should I try to delete existing records of the same component? return: void |
| _buildAdminMenus($componentId = null) X-Ref |
| Method to build menu database entries for a component param: int|null $componentId The component ID for which I'm building menus return: boolean True if successful |
| _removeAdminMenus($id) X-Ref |
| Method to remove admin menu references to a component param: int $id The ID of the extension whose admin menus will be removed return: boolean True if successful. |
| _updateSiteMenus($componentId = null) X-Ref |
| Method to update menu database entries for a component in case the component has been uninstalled before. NOTE: This will not update admin menus. Use _updateMenus() instead to update admin menus ase well. param: int|null $componentId The component ID. return: boolean True if successful |
| _updateMenus($componentId, $clientId = null) X-Ref |
| Method to update menu database entries for a component in case if the component has been uninstalled before. param: int|null $componentId The component ID. param: int $clientId The client id return: boolean True if successful |
| _rollback_menu($step) X-Ref |
| Custom rollback method - Roll back the component menu item param: array $step Installation step to rollback. return: boolean True on success |
| discover() X-Ref |
| Discover unregistered extensions. return: array A list of extensions. |
| refreshManifestCache() X-Ref |
| Refreshes the extension table cache return: boolean Result of operation, true if updated, false on failure |
| _createAdminMenuItem(array &$data, $parentId) X-Ref |
| Creates the menu item in the database. If the item already exists it tries to remove it and create it afresh. param: array &$data The menu item data to create param: integer $parentId The parent menu item ID return: boolean|integer Menu item ID on success, false on failure |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |