Joomla API

Joomla display() Method

Joomla display() Method

Base Controller

Typical view method for MVC based architecture. This function is to provide as a default implementation. In most cases, you will need to override it in your own controllers.

Continue Reading

Joomla execute() Method

Joomla execute() Method

Base Controller

Execute a task by triggering a method in the derived class.

Continue Reading

Joomla getModel() Method

Joomla getModel() Method

Base Controller

Method to get a model object, loading it if required.

Continue Reading

Joomla setMessage() Method

Joomla setMessage() Method

Base Controller

Sets the internal message that is passed with a redirect.

Continue Reading

JHtmlForm Joomla Class

JHtmlForm Joomla Class

The JHtmlForm is a utility class for form elements. It has two methods: token and csrf.

Continue Reading

JHtmlFormbehavior Joomla Class

JHtmlFormbehavior Joomla Class

JHtmlFormbehavior is utility class for form related behaviors. This class has two methods - ajaxchosen and chosen.

Continue Reading

JHtmlGrid Joomla Class

JHtmlGrid Joomla Class

JHtmlGrid is utility class for creating HTML Grids.

Continue Reading

Joomla addIncludePath() Method of Base Model

Joomla addIncludePath() Method of Base Model

Base Database Model

The method adds a directory where Joomla should search for models. You may either pass a string or an array of directories.

Continue Reading

Joomla validate() Method

Joomla validate() Method

Form Model

It is a method to validate the form data.

Continue Reading

Joomla getTable() Method

Joomla getTable() Method

Base Database Model

It is a method to get a table object, load it if necessary.

Continue Reading

Joomla getName() Method of Base Controller

Joomla getName() Method of Base Controller

Base Controller

It is a method to get the controller name. The dispatcher name is set by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor.

Continue Reading

Joomla getTask() and getTasks() Method

Joomla getTask() and getTasks() Method

Base Controller

The getTask() gets the last task that is being performed or was most recently performed.

Continue Reading

Joomla getView() Method

Joomla getView() Method

Base Controller

It is a method to get a reference to the current view and load it if necessary.

Continue Reading

Joomla checkToken() Method

Joomla checkToken() Method

Base Controller

It checks for a form token in the request. This function is used in conjunction with \JHtml::_('form.token') or \JSession::getFormToken.

Continue Reading

Joomla publish() Method of Admin Model

Joomla publish() Method of Admin Model

Admin Model

It is a method to change the published state of one or more records.

Continue Reading

Joomla display() Method of Html View

Joomla display() Method of Html View

Html View

The function executes and displays a template script.

Continue Reading

Joomla loadTemplate() Method

Joomla loadTemplate() Method

Html View

The function loads a template file. It first looks in the templates folder for an override.

Continue Reading

Joomla setDocumentTitle() Method

Joomla setDocumentTitle() Method

Html View

The function sets the document title according to global configuration options.

Continue Reading

Joomla addViewPath() Method of Base Controller

Joomla addViewPath() Method of Base Controller

Base Controller

The function adds one or more view paths to the controller's stack, in LIFO order.

Continue Reading

Joomla checkin() Method of Admin Controller

Joomla checkin() Method of Admin Controller

Admin Controller

This function is used to check-in of one or more records.

Continue Reading

Joomla saveOrderAjax() Method of Admin Controller

Joomla saveOrderAjax() Method of Admin Controller

Admin Controller

This method saves the submitted ordering values for records via AJAX.

Continue Reading

Joomla reorder() Method of Admin Model

Joomla reorder() Method of Admin Model

Admin Model

This method is used to adjust the ordering of a row. It returns NULL if the user did not have edit privileges for any of the selected primary keys.

Continue Reading

Joomla saveorder() Method of Admin Model

Joomla saveorder() Method of Admin Model

Admin Model

The function saves the manually set order of records.

Continue Reading

Joomla getItems() Method

Joomla getItems() Method

List Model

This method is used to get an array of data items.

Continue Reading

Joomla redirect() Method of Base Controller

Joomla redirect() Method of Base Controller

Base Controller

This method redirects the browser or returns false if no redirect is set.

Continue Reading

Joomla registerTask() Method

Joomla registerTask() Method

Base Controller

This method registers or maps a task to a method in the class.

Continue Reading

Joomla registerDefaultTask() Method

Joomla registerDefaultTask() Method

Base Controller

This method registers the default task to perform if a mapping is not found.

Continue Reading

Joomla unregisterTask() Method

Joomla unregisterTask() Method

Base Controller

This method unregisters or unmaps a task in the class.

Continue Reading

Joomla getName() Method of Base Model

Joomla getName() Method of Base Model

Base Database Model

It is a method to get the model name. By default, the model name is parsed using the classname or it can be set by passing a $config['name'] in the class constructor.

Continue Reading

Joomla loadHistory() Method of Base Model

Joomla loadHistory() Method of Base Model

Base Database Model

It is a method to load a row for editing from the version history table.

Continue Reading

Joomla batch() Method of Admin Model

Joomla batch() Method of Admin Model

Admin Model

It is a method to perform batch operations on an item or a set of items.

Continue Reading

Joomla setModel() Method of Html View

Joomla setModel() Method of Html View

Html View

It is a method to add a model to the view. Joomla supports a multiple-model single view system by which models are referenced by classname. A caveat to the classname referencing is that any classname prepended by \JModel will be referenced by the name without \JModel. For example, \JModelCategory is just Category.

Continue Reading

Joomla escape() Method

Joomla escape() Method

Html View

The function escapes a value for output in a view script. The ENT_COMPAT flag will be replaced by ENT_QUOTES in Joomla 4.0 to also escape single quotes.

Continue Reading

Joomla get() Method of Html View

Joomla get() Method of Html View

Html View

It is a method to get data from a registered model or a property of the view.

Continue Reading

Joomla getPagination() Method

Joomla getPagination() Method

List Model

It is a method to get a \JPagination object for the data set.

Continue Reading

Joomla getTotal() Method

Joomla getTotal() Method

List Model

It is a method to get the total number of items for the data set.

Continue Reading

Joomla getStart() Method

Joomla getStart() Method

List Model

It is a method to get the starting number of items for the data set.

Continue Reading