Actions

Difference between revisions of "Framework (CMS 1.5 and 1.6)"

From Joomla! Documentation

(Added class list.)
m (API Reference: spacing)
 
(38 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{RightTOC}}
+
{{Chunk:Framework quote}}
[[Category:Development]]
+
{{Chunk:Framework (CMS 1.5 and 1.6)}}
[[Category:Framework]]
+
== API Reference ==
<blockquote>
+
''A '''software framework''' is a reusable design for a software system (or subsystem). This is expressed as a set of [[:Wikipedia:abstract class|abstract class]]es and the way their instances collaborate for a specific type of software. Software frameworks can be [[:Wikipedia:Object-oriented programming|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 [[:Wikipedia:Libraries|libraries]]<ref>[[PHP libraries]] bundled with Joomla!</ref>, a [[:Wikipedia:JavaScript|scripting language]]<ref>[[JavaScript libraries]] bundled with Joomla!</ref>, 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 ([[:Wikipedia:Application programming interface|API]]).''
+
:''From [[:Wikipedia:Framework|Wikipedia]]''
+
</blockquote>
+
  
= Joomla! Framework =
+
On this page we'd like to provide you a way to reference of all classes and respective methods. Use the links below to navigate to further information about framework versions or the version classes which include, where possible, examples of use.
[[:Category:Joomla! 1.5|Joomla! 1.5]] is a three tiered system. The bottom tier is the framework level and consists of the [[:Category:Framework package|libraries]] and plugins (formerly known as mambots). The second tier is the application level and consists of the [[JApplication]] class. Currently there are four<ref>The fourth, "hidden" application is the [[XMP-RPC]] server.</ref> applications that ship with Joomla: [[JInstallation]], [[JAdministrator]] and [[JSite]]. The application acts as the main controller for the page.  
+
  
The third tier is the [[Extension|extension level]]. This level is where all [[:Component|component]], [[Module|module]], and [[Template|template]] logic is executed and rendered.
+
If you would like to help us improve this resource, please read about the [[API Reference Project]].
  
== Application Constants ==
+
{{Navbox
 +
|state=off
 +
|navbar=off
 +
|title=API documentation is available in the following '''Joomla! Framework Versions'''
 +
|titlestyle=font-weight:normal; padding:5px;
 +
|image=[[File:Joomla vert logo.png|120px]]
 +
|group1= Select a framework version
 +
|group2= See also
 +
|group1style=font-size:1.1em; width:18%;
 +
|list1=
 +
* [[API15:Framework|Framework]] {{JVer|1.5}}
 +
* [[API16:Framework|Framework]] {{JVer|1.6}}
 +
|list2=
 +
* [[API17:Platform|Platform]] {{JVer|11.1}}
 +
|list1style=padding-left:10px; font-size:1.2em;
 +
|list2style=padding-left:10px; font-size:1.2em;
 +
}}
  
Each application type defines several constants:
 
  
JPATH_ROOT          The path to the installed Joomla! site
+
=== See Also ===
JPATH_SITE          The path to the installed Joomla! site
+
<references/>
JPATH_CONFIGURATION The path to folder containing the configuration.php file
+
=== Further Reading ===
JPATH_ADMINISTRATOR The path to the administrator folder
+
*[[Joomla! Framework vs Joomla! Platform]]
JPATH_XMLRPC        The path to the XML-RPC Web service folder
+
<noinclude>[[Category:Framework]][[Category:Subpackages]]</noinclude>
JPATH_LIBRARIES    The path to the libraries folder
+
JPATH_PLUGINS      The path to the plugins folder
+
JPATH_INSTALLATION  The path to the installation folder
+
JPATH_THEMES        The path to the templates folder
+
JPATH_CACHE        The path to the cache folder
+
JPATH_COMPONENT    The path to the current component being executed
+
 
+
These constants are defined in <code>_path_/includes/defines.php</code>
+
 
+
== Packages and Classes ==
+
The classes in the {{jf}} are loosely grouped into several different packages.
+
 
+
* [[JFactory]]
+
* [[JRoute]]
+
* [[JText]]
+
* [[JVersion]]
+
===Application===
+
* [[JApplication]]
+
* [[JApplicationHelper]]
+
* [[JMenu]]
+
* [[JPathway]]
+
* [[JRouter]]
+
* [[JController]]
+
* [[JComponentHelper]]
+
* [[JModel]]
+
* [[JView]]
+
* [[JModuleHelper]]
+
===Base===
+
* [[JObject]]
+
* [[JObservable]]
+
* [[JObserver]]
+
* [[JTree]]
+
* [[JNode]]
+
===Cache===
+
* [[JCache]]
+
* [[JCacheStorage]]
+
* [[JCacheCallback]]
+
* [[JCacheOutput]]
+
* [[JCachePage]]
+
* [[JCacheView]]
+
* [[JCacheStorageApc]]
+
* [[JCacheStorageEaccelerator]]
+
* [[JCacheStorageFile]]
+
* [[JCacheStorageMemcache]]
+
* [[JCacheStorageXCache]]
+
* [[JFTP]]
+
===Client===
+
* [[JClientHelper]]
+
* [[JLDAP]]
+
===Database===
+
* [[JDatabase]]
+
* [[JRecordset]]
+
* [[JTable]]
+
* [[JDatabaseMySQL]]
+
* [[JDatabaseMySQLi]]
+
* [[JTableARO]]
+
* [[JTableAROGroup]]
+
* [[JTableCategory]]
+
* [[JTableComponent]]
+
* [[JTableContent]]
+
* [[JTableMenu]]
+
* [[JTableMenuTypes]]
+
* [[JTableModule]]
+
* [[JTablePlugin]]
+
* [[JTableSection]]
+
* [[JTableSession]]
+
* [[JTableUser]]
+
===Document===
+
* [[JDocument]]
+
* [[JDocumentRenderer]]
+
* [[JDocumentError]]
+
* [[JDocumentFeed]]
+
* [[JDocumentRendererAtom]]
+
* [[JDocumentRendererRSS]]
+
* [[JDocumentHTML]]
+
* [[JDocumentRendererComponent]]
+
* [[JDocumentRendererHead]]
+
* [[JDocumentRendererMessage]]
+
* [[JDocumentRendererModule]]
+
* [[JDocumentRendererModules]]
+
* [[JDocumentPDF]]
+
* [[JDocumentRaw]]
+
===Environment===
+
* [[JBrowser]]
+
* [[JRequest]]
+
* [[JResponse]]
+
* [[JURI]]
+
===Error===
+
* [[JError]]
+
* [[JException]]
+
* [[JLog]]
+
* [[JProfiler]]
+
===Event===
+
* [[JDispatcher]]
+
* [[JEvent]]
+
===Filesystem===
+
* [[JArchive]]
+
* [[JFile]]
+
* [[JFolder]]
+
* [[JPath]]
+
* [[JArchiveBzip2]]
+
* [[JArchiveGzip]]
+
* [[JArchiveTar]]
+
* [[JArchiveZip]]
+
===Filter===
+
* [[JFilterInput]]
+
* [[JFilterOutput]]
+
===HTML===
+
* [[JEditor]]
+
* [[JHTML]]
+
* [[JPagination]]
+
* [[JPane]]
+
* [[JParameter]]
+
* [[JToolBar]]
+
* [[JHTMLBehavior]]
+
* [[JHTMLContent]]
+
* [[JHTMLEmail]]
+
* [[JHTMLForm]]
+
* [[JHTMLGrid]]
+
* [[JHTMLImage]]
+
* [[JHTMLList]]
+
* [[JHTMLMenu]]
+
* [[JHTMLSelect]]
+
* [[JElement]]
+
* [[JElementCalendar]]
+
* [[JElementCategory]]
+
* [[JElementEditors]]
+
* [[JElementFileList]]
+
* [[JElementFolderList]]
+
* [[JElementHelpsites]]
+
* [[JElementHidden]]
+
* [[JElementImageList]]
+
* [[JElementLanguages]]
+
* [[JElementList]]
+
* [[JElementMenu]]
+
* [[JElementMenuItem]]
+
* [[JElementPassword]]
+
* [[JElementRadio]]
+
* [[JElementSection]]
+
* [[JElementSpacer]]
+
* [[JElementSQL]]
+
* [[JElementText]]
+
* [[JElementTextarea]]
+
* [[JElementTimezones]]
+
* [[JElementUserGroup]]
+
* [[JButton]]
+
* [[JButtonConfirm]]
+
* [[JButtonCustom]]
+
* [[JButtonHelp]]
+
* [[JButtonLink]]
+
* [[JButtonPopup]]
+
* [[JButtonSeparator]]
+
* [[JButtonStandard]]
+
===Installer===
+
* [[JInstallerHelper]]
+
* [[JInstaller]]
+
* [[JInstallerComponent]]
+
* [[JInstallerLanguage]]
+
* [[JInstallerModule]]
+
* [[JInstsallerPlugin]]
+
* [[JInstallerTemplate]]
+
===Language===
+
* [[JHelp]]
+
* [[JLanguageHelper]]
+
* [[JLanguage]]
+
===Mail===
+
* [[JMailHelper]]
+
* [[JMail]]
+
===Plugin===
+
* [[JPluginHelper]]
+
* [[JPlugin]]
+
===Registry===
+
* [[JRegistryFormat]]
+
* [[JRegistry]]
+
* [[JRegistryFormatINI]]
+
* [[JRegistryFormatPHP]]
+
* [[JRegistryFormatXML]]
+
===Session===
+
* [[JSession]]
+
* [[JSessionStorage]]
+
* [[JSessionStorageApc]]
+
* [[JSessionStorageDatabase]]
+
* [[JSessionStorageEaccelerator]]
+
* [[JSessionStorageMemcache]]
+
* [[JSessionStorageNone]]
+
* [[JSessionStorageXcache]]
+
===Template===
+
This package is deprecated.  Template extensions are part of the Document package now.
+
* [[JTemplate]]
+
* [[patTemplate_Function_Sef]]
+
* [[patTemplate_Function_Translate]]
+
* [[patTemplate_Modifier_SEF]]
+
* [[patTemplate_Modifer_Translate]]
+
===User===
+
* [[JAuthentication]]
+
* [[JAuthorization]]
+
* [[JUserHelper]]
+
* [[JUser]]
+
===Utilities===
+
* [[JArrayHelper]]
+
* [[JBuffer]]
+
* [[JDate]]
+
* [[JSimpleCrypt]]
+
* [[JSimpleXML]]
+
* [[JString]]
+
* [[JUtility]]
+
 
+
==See also==
+
<references />
+

Latest revision as of 12:27, 31 August 2013

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[1], a scripting language[2], 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
The Joomla! Framework[3] was an important part of the Joomla! CMS architecture in the versions 1.5 and 1.6. It was based on modern object-oriented design patterns that make the Joomla core highly maintainable and easily extendable. Between April and July 2011, the Framework was rebranded as the Joomla! Platform and is now being developed separately from the Joomla! CMS. The first version of the CMS to ship with the Platform was version 1.7.

Third party developers benefit from the rich, and easily accessible functionality that the Joomla Framework provides.

The Joomla Architecture

API Reference

On this page we'd like to provide you a way to reference of all classes and respective methods. Use the links below to navigate to further information about framework versions or the version classes which include, where possible, examples of use.

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


See Also

  1. See also External Libraries in Joomla bundled with Joomla!
  2. See also JavaScript libraries bundled with Joomla!
  3. See also Subpackages

Further Reading