joomla/model

Joomla Model Package

4.0.1 2025-07-23 20:00 UTC

Requires

• php: ^8.3.0

Requires (Dev)

• joomla/database: ^4.0
• joomla/registry: ^4.0
• phpstan/phpstan: ^2.1.17
• phpstan/phpstan-deprecation-rules: ^2.0.3
• phpunit/phpunit: ^12.2.7
• squizlabs/php_codesniffer: ^3.7.2

Suggests

• joomla/database: ^4.0 Allows using database models
• joomla/registry: ^4.0 Allows using stateful models

GPL-2.0-or-later

• framework
• model
• joomla

README

Interfaces

Model\ModelInterface

Model\ModelInterface is an interface that requires a class to be implemented with a getState and a setState method.

Classes

Model\AbstractModel

Construction

The contructor for a new Model\AbstractModel object takes an optional Registry object that defines the state of the model. If omitted, an empty Registry object will be assigned automatically.

Usage

The Model\AbstractModel class is abstract. All requirements of the interface are already satisfied by the base class.

namespace MyApp;

use Joomla\Model\AbstractModel;

/**
 * My custom model.
 *
 * @pacakge  Examples
 *
 * @since   1.0
 */
class MyModel extends AbstractModel
{
  /**
	 * Get the time.
	 *
	 * @return  integer
	 *
	 * @since   1.0
	 */
	public function getTime()
	{
		return time();
	}
}

Model\AbstractDatabaseModel

Construction

Model\AbstractDatabaseModel is extended from Model\AbstractModel and the contructor takes a required Database\DatabaseDriver object and an optional Registry object.

Usage

The Model\AbstractDatabaseModel class is abstract so cannot be used directly. It forms a base for any model that needs to interact with a database.

namespace MyApp

use Joomla\Model;
use Joomla\Database;

/**
 * My custom database model.
 *
 * @package  Examples
 *
 * @since   1.0
 */
class MyDatabaseModel extends Model\AbstractDatabaseModel
{
	/**
	 * Get the content count.
	 *
	 * @return  integer
	 *
	 * @since   1.0
	 * @throws  RuntimeException on database error.
	 */
	public function getCount()
	{
		// Get the query builder from the internal database object.
		$q = $this->db->getQuery(true);

		// Prepare the query to count the number of content records.
		$q->select('COUNT(*)')->from($q->qn('#__content'));

		$this->db->setQuery($q);

		// Execute and return the result.
		return $this->db->loadResult();
	}
}

try
{
	$driver = Database\DatabaseFactory::getInstance()->getDriver('mysqli');
	$model = new MyDatabaseModel($driver);
	$count = $model->getCount();
}
catch (RuntimeException $e)
{
	// Handle database error.
}

Installation via Composer

Add "joomla/model": "~3.0" to the require block in your composer.json and then run composer install.

{
	"require": {
		"joomla/model": "~3.0"
	}
}

Alternatively, you can simply run the following from the command line:

composer require joomla/model "~3.0"