API Guides: Difference between revisions
From Joomla! Documentation
m Link to How to use the filesystem package |
m Ajax added |
||
| Line 7: | Line 7: | ||
Around Joomla 3.8 the Joomla development team began changing the naming convention of Joomla classes to use namespaces, so that for example JFactory changed to Factory in the Joomla\CMS namespace. As you read existing Joomla code and documentation you may find the classes following either the new or the old naming standard. You can find the mapping between the two naming conventions in the <tt>libraries/classmap.php</tt> file in your Joomla instance. | Around Joomla 3.8 the Joomla development team began changing the naming convention of Joomla classes to use namespaces, so that for example JFactory changed to Factory in the Joomla\CMS namespace. As you read existing Joomla code and documentation you may find the classes following either the new or the old naming standard. You can find the mapping between the two naming conventions in the <tt>libraries/classmap.php</tt> file in your Joomla instance. | ||
* Ajax handling within Joomla Components is described in [[JSON Responses with JResponseJson]]. Ajax can also be used within Joomla Modules and Plugins as described in [[Using Joomla Ajax Interface]]. | |||
* [[Categories and CategoryNodes API Guide|Categories]] Using the <tt>Categories</tt> and <tt>CategoryNode</tt> classes to access data relating to Joomla categories | * [[Categories and CategoryNodes API Guide|Categories]] Using the <tt>Categories</tt> and <tt>CategoryNode</tt> classes to access data relating to Joomla categories | ||
* Database / JDatabase. There are two API guides, covering [[Selecting data using JDatabase]] and [[Inserting, Updating and Removing data using JDatabase]] | * Database / JDatabase. There are two API guides, covering [[Selecting data using JDatabase]] and [[Inserting, Updating and Removing data using JDatabase]] | ||
| Line 15: | Line 16: | ||
* [[Using JLog|Log / JLog]] Log messages (eg error messages, debug messages) to a log file, and optionally to the debug console | * [[Using JLog|Log / JLog]] Log messages (eg error messages, debug messages) to a log file, and optionally to the debug console | ||
* [[Menu and Menuitems API Guide|Menu and Menuitems]] | * [[Menu and Menuitems API Guide|Menu and Menuitems]] | ||
* [[JSON_Responses_with_JResponseJson|JResponseJson]] supports responding in JSON format to Ajax requests. | |||
* Route / JRoute see [[URLs in Joomla]] | * Route / JRoute see [[URLs in Joomla]] | ||
* Table / JTable provides functionality for performing CRUD operations (and more) on database tables. The guide is split into a [[Table Basic API Guide|Basic API Guide]] and an [[Table Advanced API Guide|Advanced API Guide]] | * Table / JTable provides functionality for performing CRUD operations (and more) on database tables. The guide is split into a [[Table Basic API Guide|Basic API Guide]] and an [[Table Advanced API Guide|Advanced API Guide]] | ||
Revision as of 13:28, 29 December 2019
This page contains an index to the set of Joomla API Guides. These guides aim to help you understand how to use these Joomla functions in your own Joomla extensions.
Each API guide includes sample code which you can copy and install in your own development environment. Generally these code samples are written to be included and installed as Joomla module, so if you're not familiar with Joomla module development you may find going through the short series Creating a Simple Module useful.
Note that this is work in progress!
Around Joomla 3.8 the Joomla development team began changing the naming convention of Joomla classes to use namespaces, so that for example JFactory changed to Factory in the Joomla\CMS namespace. As you read existing Joomla code and documentation you may find the classes following either the new or the old naming standard. You can find the mapping between the two naming conventions in the libraries/classmap.php file in your Joomla instance.
- Ajax handling within Joomla Components is described in JSON Responses with JResponseJson. Ajax can also be used within Joomla Modules and Plugins as described in Using Joomla Ajax Interface.
- Categories Using the Categories and CategoryNode classes to access data relating to Joomla categories
- Database / JDatabase. There are two API guides, covering Selecting data using JDatabase and Inserting, Updating and Removing data using JDatabase
- Files and Folders. See How to use the filesystem package.
- Form / JForm. There is a Basic guide to using the Joomla Form API and incorporating forms within a Joomla component, and also a more Advanced form guide covering more advanced aspects of the APIs.
- FormField / JFormField. This class and related classes such as JFormFieldList which inherit from it are primarily useful for defining custom form fields, as described in Creating a custom form field type.
- Input / JInput Using the Input class to obtain the values of parameters in HTTP GET and POST requests
- Log / JLog Log messages (eg error messages, debug messages) to a log file, and optionally to the debug console
- Menu and Menuitems
- JResponseJson supports responding in JSON format to Ajax requests.
- Route / JRoute see URLs in Joomla
- Table / JTable provides functionality for performing CRUD operations (and more) on database tables. The guide is split into a Basic API Guide and an Advanced API Guide
- Uri / JUri see URLs in Joomla
- User / JUser API related to the Joomla User.