joomla/model

Joomla Model Package

The Model Package

, _(*1)

Interfaces

Model\ModelInterface

Model\ModelInterface is an interface that requires a class to be implemented with a getState and a setState method., _(*2)

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., _(*3)

Usage

The Model\AbstractModel class is abstract. All requirements of the interface are already satisfied by the base class., _(*4)

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., _(*5)

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., _(*6)

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": "~1.0" to the require block in your composer.json and then run composer install., _(*7)

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

Alternatively, you can simply run the following from the command line:, _(*8)

composer require joomla/model "~1.0"