Molajo ModelController

ModelController.php

<?php
/**
 * @package   Molajo
 * @copyright 2012 Amy Stephen. All rights reserved.
 * @license   GNU General Public License Version 2, or later http://www.gnu.org/licenses/gpl.html
 */
namespace Molajo\MVC\Controller;

use Molajo\Service\Services\Configuration\ConfigurationService;
use Molajo\Service\Services;

defined('MOLAJO') or die;

/**
 * Model Controller
 *
 * The class merely allows all model instantiation as a common gateway
 *
 * There are two basic process flows to the Model within the Molajo Application:
 *
 * 1. The first is directly related to processing the request and using the MVC
 *     architecture to either render output or execute the action action.
 *
 *   -> For rendering, the Parser and Includer gather data needed and execute
 *         the Controller action to activate the MVC.
 *
 *   -> For action actions, the Controller action is initiated in the Application class.
 *
 *  The Controller then interacts with the Model for data requests.
 *
 * 2. The second logic flow routes support queries originating in Service and Helper
 *  classes and pass through this Controller to invoke the Model, as needed.
 *
 * @package     Molajo
 * @subpackage  Model
 * @since       1.0
 */
Class ModelController extends Controller
{
	/**
	 * Static instance
	 *
	 * @var    object
	 * @since  1.0
	 */
	protected static $instance;

	/**
	 * getInstance
	 *
	 * @static
	 * @return bool|object
	 * @since  1.0
	 */
	public static function getInstance()
	{
		if (empty(self::$instance)) {
			self::$instance = new ModelController();
		}
		return self::$instance;
	}

	/**
	 * Constructor.
	 *
	 * @since  1.0
	 */
	public function __construct()
	{
		return parent::__construct();
	}

	/**
	 * Prepares data needed for the model using an XML table definition
	 *
	 * @param  string  $table
	 * @param  string  $type
	 *
	 * @return object
	 *
	 * @since   1.0
	 * @throws \RuntimeException
	 */
	public function connect($table = '', $type = null)
	{
		if ($type == null) {
			$type = 'Table';
		}

		if ($table === '') {
			$this->dataSource = $this->default_dataSource;

		} else {
			$table_registry_name = ucfirst(strtolower($table)) . ucfirst(strtolower($type));

			if (Services::Registry()->exists($table_registry_name)) {
				$this->table_registry_name = $table_registry_name;

			} else {
				$this->table_registry_name = ConfigurationService::getFile($table, $type);
			}
		}

		/* 2. Instantiate Model Class */
		$modelClass = 'Molajo\\MVC\\Model\\EntryModel';

		try {
			$this->model = new $modelClass();
		}
		catch (\Exception $e) {
			throw new \RuntimeException('Model entry failed. Error: ' . $e->getMessage());
		}
		/** 3. Model Properties         */
		$this->model->set('table_registry_name', $this->table_registry_name);
		$this->model->set('model_name', Services::Registry()->get($this->table_registry_name, 'model_name'));
		$this->model->set('table_name', Services::Registry()->get($this->table_registry_name, 'table_name'));
		$this->model->set('primary_key', Services::Registry()->get($this->table_registry_name, 'primary_key'));
		$this->model->set('id', Services::Registry()->get($this->table_registry_name, 'id'));
		$this->model->set('primary_prefix', Services::Registry()->get($this->table_registry_name, 'primary_prefix'));
		$this->model->set('name_key', Services::Registry()->get($this->table_registry_name, 'name_key'));
		$this->model->set('id_name', Services::Registry()->get($this->table_registry_name, 'id_name'));

		/** 4. Set DB Properties (note: 'mock' DBO's are used for processing non-DB data, like Messages    */
		$dbo = Services::Registry()->get($this->table_registry_name, 'data_source');

		$this->model->set('db', Services::$dbo()->get('db'));
		$this->model->set('query', Services::$dbo()->getQuery());
		$this->model->set('nullDate', Services::$dbo()->get('db')->getNullDate());

		if ($dbo == 'JDatabase') {
			$dateClass = 'Joomla\\date\\JDate';
			$dateFromJDate = new $dateClass('now');
			$now = $dateFromJDate->toSql(false, Services::$dbo()->get('db'));
			$this->model->set('now', $now);
		}

		Services::$dbo()->getQuery()->clear();

		return $this;
	}

	/**
	 * Method to execute a model method which interacts with the data source
	 * and returns results
	 *
	 * @param  string  $query_object
	 *
	 * @return  mixed Depends on QueryObject selected
	 *
	 * @since   1.0
	 * @throws \RuntimeException
	 */
	public function getData($query_object = 'loadObjectList', $view_requested = false)
	{
		
		if (in_array($query_object, $this->query_objects)) {
		} else {
			$query_object = 'loadObjectList';
		}

		try {
			/** Sometimes, only the data is requested */
			if ($view_requested == true) {
				$this->parameters['query_object'] = $query_object;
				return $this->display();

			} else {
				return $this->model->$query_object();
			}

		} catch (\Exception $e) {
			throw new \RuntimeException('Model query failed for ' . $query_object . ' Error: ' . $e->getMessage());
		}
	}
}

All interaction with databases goes through Molajo's Model, and this is the single entry point by which all model traffic is directed.

Molajo uses xml table definitions to describe fields, filters, foreign keys, children, special joins, and custom fields, including parameters and metadata. These definitions are processed by the Model so that no code is required to interact with tables.

In addition, data sources that mock the database interaction are used so that all data flowing into the forms is processed by Molajo's models. That includes such data as messages, assets (JS, CSS, etc.), parameter-values and filesystem interaction.

There is no direct interaction with a data source (i.e., a database or mock database) outside of Molajo's models.