eurecap.php

<?php
if( !defined( '_JEXEC' ) ) die( 'Direct Access to '.basename(__FILE__).' is not allowed.' );

/**
*
* @package VirtueMart
* @subpackage EU Recapitulative Statement
* @copyright Copyright (C) 2015 Open Tools, Reinhold Kainhofer.
* @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.txt
* VirtueMart is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*
* http://www.open-tools.net
*/

defined ('VMPATH_ADMIN') or define ('VMPATH_ADMIN', JPATH_VM_ADMINISTRATOR);
defined ('VMPATH_PLUGINLIBS') or define ('VMPATH_PLUGINLIBS', JPATH_VM_PLUGINS);
if (!class_exists('vmExtendedPlugin')) require(VMPATH_PLUGINLIBS . DS . 'vmextendedplugin.php');

class plgVmExtendedEuRecap extends vmExtendedPlugin {

	public function __construct (&$subject, $config=array()) {
		parent::__construct($subject, $config);
		$this->_path = JPATH_PLUGINS.DS.'vmextended'.DS.$this->getName();
		JPlugin::loadLanguage('plg_vmextended_'.$this->getName());
	}

//     public function getVmPluginCreateTableSQL () {
//     }

    /* In versions before VM 2.6.8, the onStoreInstallPluginTable function was protected, so the installer couldn't call it to create the plugin table...
       This function simply is a public wrapper to make this function available to the installer on all VM versions: */
    public function plgVmOnStoreInstallPluginTable($psType, $name='') {
        return $this->onStoreInstallPluginTable($psType, $name);
    }

	/**
	 * Plugs into the backend controller logic to insert a custom controller into the VM component space
	 * This means that links can be constructed as index.php?option=com_virtuemart&view=myaddon and work
	 *
	 * @param string $controller Name of controller requested
	 * @return True if this loads a file (null otherwise)
	 */
	public function onVmAdminController ($controller) {
		if ($controller == 'eurecap') {
			VmModel::addIncludePath($this->_path . DS . 'models');

			// TODO: Make sure the model exists. We probably should find a better way to load this automatically! 
			//       Currently, some path config seems missing, so the model is not found by default.
			require_once($this->_path.DS.'models'.DS.'eurecap.php');
			require_once($this->_path.DS.'models'.DS.'eurecap_config.php');
			require_once($this->_path.DS.'controllers'.DS.'eurecap.php');
			return false;
		}
	}
	
	/**
	 * The onVmAdminMenuItems($moduleId) trigger is supposed to return an array of admin menu entries, each of which has the following structure:
	 * array('module_id'=>1, 'module_name'=>'product', 'module_perms'=>'storeadmin,admin', 
	 *       'id'=>..., 'name'=>'COM_VIRTUEMART_PRODUCT_S', 'link'=>'', 'depends'=>'', 'icon_class'=>'vmicon vmicon-16-camera',
	 *       'view'=>'YOURVIEW', 'task'=>'', 'module_ordering'=>1, 'item_ordering'=>3)
	*/
	public function onVmAdminMenuItems($moduleId=0) {
		return array(
			array('module_id'=>14, 
				  'module_name'=>'report', 
				  'module_perms'=>'storeadmin,admin', 
				  'id'=>100877, 
				  'name'=>'COM_VIRTUEMART_EU_RECAP', 
				  'link'=>'', 
				  'depends'=>'', 
				  'icon_class'=>'vmicon vmicon-16-report',
				  'view'=>'eurecap', 
				  'task'=>'', 
				  'module_ordering'=>4, 
				  'item_ordering'=>25,
			),
		);
	}
	
	/** 
	 * A helper function for the plugin installer: In VM 3.0.? the onVmAdminMenuItems trigger might added, which allows to dynamically
	 * add admin menu items to the the backend. In earlier versions, we need to hardcode the menu item to the database. This function
	 * decides whether the database entry is needed and if so, it adds it (otherwise it removes it, just in case).
	 */
	public function onInstallCheckAdminMenuEntries() {
		$vmver = vmVersion::$RELEASE;
		$db = JFactory::getDBO();
		$db->setQuery("SELECT `id` FROM `#__virtuemart_adminmenuentries` WHERE `view` = 'eurecap'");
		$exists = $db->loadResult();
// 		$need_db_entry = version_compare($vmver, '3.0.3', 'lt');
		$need_db_entry = true;
		if ($need_db_entry) {
			if (!$exists) {
				// Before VM 3.0.3 => Need database entry (in the "Orders" section):
				$q = "INSERT INTO `#__virtuemart_adminmenuentries` (`module_id`, `name`, `link`, `depends`, `icon_class`, `ordering`, `published`, `tooltip`, `view`, `task`) VALUES
(2, '" . vmText::_('COM_VIRTUEMART_EU_RECAP') . "', '', '', 'vmicon vmicon-16-report', 25, 1, '', 'eurecap', '')";
				$db->setQuery($q);
				$db->query();
			}
		} else {
			if ($exists) {
				$q = "DELETE FROM `#__virtuemart_adminmenuentries` WHERE `view` = 'eurecap' AND `task` = '' AND `module_id` = 2";
				$db->setQuery($q);
				$db->query();
			}
		}
	}

}