How to override the component mvc from the Joomla! core
Contents |
NOTICE
This method only works if you install and enable the 3rd party MVC plugin - or provide your own equivalent plugin. It is fine for advanced developers - just be aware that this is not part of Joomla! Core code
Summary
There may be times when you need to override the Joomla! MVC Component to add new functionality or to completely customise the component. The MVC component can be completely overridden by using the same class names that are used in the component. This is achieved by loading a system plugin before the component is dispatched by the application.
You can create your own plugin to do this.
class plgSystemComContentOverride extends JPlugin {
public function __construct(&$subject, $config = array()) {
parent::__construct($subject, $config);
}
public function onAfterRoute() {
$app = JFactory::getApplication();
if('com_content' == JRequest::getCMD('option') && !$app->isAdmin()) {
require_once(dirname(__FILE__) . DS . 'comcontentoverride' . DS . 'my_content_controller.php');
}
}
}
In the examples below we are using an Override MVC plugin
Getting a head-start with overrides
You can override by templating or by application scope (frontend/backend).
Using a templating method
Override Base Component Controller
TEMPLATE_NAME/code/COMPONENT_NAME/CONTROLLER.php
Override Another Component Controller
TEMPLATE_NAME/code/COMPONENT_NAME/controllers/CONTROLLER_NAME.php
Override Models
TEMPLATE_NAME/code/COMPONENT_NAME/models/MODEL_NAME.php
Override Views
TEMPLATE_NAME/code/COMPONENT_NAME/views/VIEW_NAME/VIEW_NAME(.FORMAT).php
Using application scope method
You can override by creating a code folder in the base path from application.
Site General Override
code/COMPONENT_NAME/CONTROLLER.php
Override Another Component Controller
code/COMPONENT_NAME/controllers/CONTROLLER_NAME.php
Override Models
code/COMPONENT_NAME/models/MODEL_NAME.php
Override Views
code/COMPONENT_NAME/views/VIEW_NAME/VIEW_NAME(.FORMAT).php
Administrator General Override
administrator/code/COMPONENT_NAME/CONTROLLER.php
Override Another Component Controller
administrator/code/COMPONENT_NAME/controllers/CONTROLLER_NAME.php
Override Models
administrator/code/COMPONENT_NAME/models/MODEL_NAME.php
Override Views
administrator/code/COMPONENT_NAME/views/VIEW_NAME/VIEW_NAME(.FORMAT).php
Extending Default Class
if you ENABLE the override class functionality you can extend original classes and override your custom methods.
See this example with banner controller:
file: administrator/code/com_banners/controller.php
/**
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access
defined('_JEXEC') or die;
/**
* Banners master display controller.
*
* @package Joomla.Administrator
* @subpackage com_banners
* @since 1.6
*/
class BannersController extends BannersControllerDefault
{
//your custom methods here
}