Joomla! Documentation™

A software framework is a reusable design for a software system (or subsystem). This is expressed as a set of abstract classes and the way their instances collaborate for a specific type of software. Software frameworks can be object-oriented designs. Although designs don't have to be implemented in an object-oriented language, they usually are. A software framework may include support programs, code libraries, a scripting language, or other software to help develop and glue together the different components of a software project. Various parts of the framework may be exposed through an application programming interface (API).

From Wikipedia

Joomla! 1.5 is a three tiered system:-

• The top, Extensions layer, consists of Extensions to the Joomla Framework and its applications:
  • Modules
  • Components
  • Templates
• The middle, Application layer, consists of applications that extend the Framework JApplication class. Currently there are four applications included in the Joomla distribution:-
  • JInstallation is responsible for installing Joomla on a web server and is deleted after the installation procedure has been completed.
  • JAdministrator is responsible for the back-end Administrator.
  • JSite is responsible for the front-end of the website.
  • XML-RPC supports remote administration of the Joomla website.
• The bottom, Framework layer, consists of:-
  • the Joomla Framework itself, whose classes are listed below.
  • Libraries that are required by the Framework or are installed for use by third-party developers.
  • Plugins extend the functionality available in the Framework.

Packages and Classes

The classes in the Joomla! Framework are loosely grouped into several different packages, listed below. The links will take you to further information about each class including, where possible, examples of use. You can also browse the Joomla Framework and included libraries on api.joomla.org which is automatically generated by the phpDocumentor package from an analysis of the Joomla! source code, making use of specially formatted comments embedded in the source code itself. These two resources, one manually maintained, the other automatic, are intended to complement one another.

If you would like to help us improve this resource, please read API Reference Project.

For an alphabetical list of class names click on the "Class" column heading.

Subpackage	Class	Comments
	JFactory
	JRoute
	JText
	JVersion
Access	JAccess
Access	JAccessHelper
Access	JAccessLevel
Access	JHtmlAccess
Access	JRule
Access	JRules
Access	JSimpleRule
Application	JApplication
Application	JApplicationHelper
Application	JCategoryTree
Application	JCategoryNode
Application	JComponentHelper
Application	JController
Application	JMenu
Application	JModel
Application	JModelItem
Application	JModelList
Application	JModuleHelper
Application	JPathway
Application	JRouter
Application	JView
Backup	JBackup
Backup	JBackupFilesystem
Backup	JBackupSql
Backup	JBackupTable
Base	JAdapter
Base	JAdapterInstance
Base	JClass
Base	JObject
Base	JObservable
Base	JObserver
Base	JTree
Base	JNode
Cache	JCache
Cache	JCacheCallback
Cache	JCacheOutput
Cache	JCachePage
Cache	JCacheStorage
Cache	JCacheStorageApc
Cache	JCacheStorageEaccelerator
Cache	JCacheStorageFile
Cache	JCacheStorageMemcache
Cache	JCacheStorageXCache
Cache	JCacheView
Client	JClientHelper
Client	JFTP
Client	JLDAP
Database	JDatabase
Database	JDatabaseMySQL
Database	JDatabaseMySQLi
Database	JDataLoad
Database	JDataLoaderSQL
Database	JQuery
Database	JQueryElement
Database	JRecordSet
Database	JTable
Database	JTableARO
Database	JTableAROGroup
Database	JTableAsset
Database	JTableBackup
Database	JTableBackupEntry
Database	JTableCategory
Database	JTableComponent
Database	JTableContent
Database	JTableExtension
Database	JTableMenu
Database	JTableMenuTypes
Database	JTableModule
Database	JTableNested
Database	JTablePlugin
Database	JTableSection
Database	JTableSession
Database	JTableTree
Database	JTableUpdate
Database	JTableUser
Database	JTableUsergroup
Document	JDocument
Document	JDocumentError
Document	JDocumentFeed
Document	JDocumentHTML
Document	JDocumentJSON
Document	JDocumentPDF
Document	JDocumentRaw
Document	JDocumentRenderer
Document	JDocumentRendererAtom
Document	JDocumentRendererComponent
Document	JDocumentRendererHead
Document	JDocumentRendererInstallation
Document	JDocumentRendererMessage
Document	JDocumentRendererModule
Document	JDocumentRendererModules
Document	JDocumentRendererRSS
Document	JDocumentVCARD
Document	JDocumentXML
Document	JFeedEnclosure
Document	JFeedImage
Document	JFeedItem
Environment	JBrowser
Environment	JRequest
Environment	JResponse
Environment	JURI
Error	JError
Error	JException
Error	JLog
Error	JProfiler
Event	JDispatcher
Event	JEvent
Filesystem	JArchive
Filesystem	JArchiveBzip2
Filesystem	JArchiveGzip
Filesystem	JArchiveTar
Filesystem	JArchiveZip
Filesystem	JFile
Filesystem	JFilesystem
Filesystem	JFilesystemFTP
Filesystem	JFilesystemHelper
Filesystem	JFilesystemSSH
Filesystem	JFilesystemPHP
Filesystem	JFolder
Filesystem	JPath
Filesystem	JStream
Filesystem	JStreamString
Filesystem	JStringController
Filter	JFilterInput
Filter	JFilterOutput
Form	JForm
Form	JFormField
Form	JFormFieldAccessLevels
Form	JFormFieldAccessSections
Form	JFormFieldCalendar
Form	JFormFieldCategories
Form	JFormFieldCheckbox
Form	JFormFieldCombo
Form	JFormFieldEditor
Form	JFormFieldEditors
Form	JFormFieldFile
Form	JFormFieldHelpsites
Form	JFormFieldHidden
Form	JFormFieldIntegers
Form	JFormFieldLanguages
Form	JFormFieldList
Form	JFormFieldMedia
Form	JFormFieldPassword
Form	JFormFieldRadio
Form	JFormFieldRules
Form	JFormFieldSpacer
Form	JFormFieldText
Form	JFormFieldTextarea
Form	JFormFieldTimezones
Form	JFormFieldUserGroups
Form	JFormRule
Form	JFormRuleBoolean
Form	JFormRuleEquals
Form	JFormRuleEmail
Form	JFormRuleRules
Form	JFormRuleUsername
Form	JFormValidator
HTML	JButton
HTML	JButtonConfirm
HTML	JButtonCustom
HTML	JButtonHelp
HTML	JButtonLink
HTML	JButtonPopup
HTML	JButtonSeparator
HTML	JButtonStandard
HTML	JEditor
HTML	JElement
HTML	JElementCalendar
HTML	JElementCategory
HTML	JElementEditors
HTML	JElementFileList
HTML	JElementFolderList
HTML	JElementHelpsites
HTML	JElementHidden
HTML	JElementImageList
HTML	JElementLanguages
HTML	JElementList
HTML	JElementList_AssetGroups
HTML	JElementMenu
HTML	JElementMenuItem
HTML	JElementPassword
HTML	JElementRadio
HTML	JElementSection
HTML	JElementSpacer
HTML	JElementSQL
HTML	JElementText
HTML	JElementTextarea
HTML	JElementTimezones
HTML	JElementUserGroup
HTML	JHtml
HTML	JHtmlAccess
HTML	JHtmlAcl
HTML	JHtmlBehavior
HTML	JHtmlContent
HTML	JHtmlEmail
HTML	JHtmlForm
HTML	JHtmlGrid
HTML	JHtmlImage
HTML	JHtmlList
HTML	JHtmlMenu
HTML	JHtmlRules
HTML	JHtmlSelect
HTML	JContent
HTML	JPagination
HTML	JPaginationObject
HTML	JPane
HTML	JPaneTabs
HTML	JPaneSliders
HTML	JParameter
HTML	JToolBar
Installer	JDependency
Installer	JExtension
Installer	JInstaller
Installer	JInstallerComponent
Installer	JInstallerFiles
Installer	JInstallerHelper
Installer	JInstallerLanguage
Installer	JInstallerLibrary
Installer	JInstallerModule
Installer	JInstallerPackage
Installer	JInstallerPlugin
Installer	JInstallerSQL
Installer	JInstallerTemplate
Installer	JLibraryManifest
Installer	JPackageManifest
Language	JHelp
Language	JLanguageHelper
Language	JLanguage
Mail	JMailHelper
Mail	JMail
Plugin	JPluginHelper
Plugin	JPlugin
Registry	JRegistry
Registry	JRegistryFormat
Registry	JRegistryFormatINI
Registry	JRegistryFormatPHP
Registry	JRegistryFormatXML
Registry	JRegistryFormatJSON
Session	JSession
Session	JSessionStorage
Session	JSessionStorageApc
Session	JSessionStorageDatabase
Session	JSessionStorageEaccelerator
Session	JSessionStorageMemcache
Session	JSessionStorageNone
Session	JSessionStorageXcache
Task	JTask
Task	JTaskSet
Template	JTemplate	This subpackage is deprecated from 1.5 onwards.
Template	patTemplate_Function_Sef	This subpackage is deprecated from 1.5 onwards.
Template	patTemplate_Function_Translate	This subpackage is deprecated from 1.5 onwards.
Template	patTemplate_Modifier_SEF	This subpackage is deprecated from 1.5 onwards.
Template	patTemplate_Modifer_Translate	This subpackage is deprecated from 1.5 onwards.
Updater	JUpdate
Updater	JUpdateAdapter
Updater	JUpdater
Updater	JUpdaterCollection
Updater	JUpdaterExtension
User	JAuthentication
User	JAuthenticationResponse
User	JAuthorization
User	JUserHelper
User	JUser
Utilities	JArrayHelper
Utilities	JBuffer
Utilities	JDate
Utilities	JSimpleCrypt
Utilities	JSimpleTemplate
Utilities	JSimpleXML	Deprecated from Joomla 1.6 onwards
Utilities	JSimpleXMLElement	Deprecated from Joomla 1.6 onwards
Utilities	JString
Utilities	JUtility