InterfaceMyModuleTrigger::__construct() - Code Metrics - Inspection of "Daily Inspection: FIX #6850" - Dolibarr/dolibarr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (59ab9a)

unknown

created 2017-05-29 16:04 UTC

InterfaceMyModuleTrigger::__construct() A

↳ Parent: InterfaceMyModuleTrigger

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	1
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0

<?php
/* <one line to give the program's name and a brief idea of what it does.>
 * Copyright (C) <year>  <name of author>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * \file    core/triggers/interface_99_modMyModule_Triggers.class.php
 * \ingroup mymodule
 * \brief   Example trigger.
 *
 * Put detailed description here.
 *
 * \remarks You can create other triggers by copying this one.
 * - File name should be either:
 *      - interface_99_modMyModule_MyTrigger.class.php
 *      - interface_99_all_MyTrigger.class.php
 * - The file must stay in core/triggers
 * - The class name must be InterfaceMytrigger
 * - The constructor method must be named InterfaceMytrigger
 * - The name property name must be MyTrigger
 */

require_once DOL_DOCUMENT_ROOT.'/core/triggers/dolibarrtriggers.class.php';


/**
 *  Class of triggers for MyModule module
 */
class InterfaceMyModuleTrigger extends DolibarrTriggers
{
	/**
	 * @var DoliDB Database handler
	 */
	protected $db;

	/**
	 * Constructor
	 *
	 * @param DoliDB $db Database handler
	 */
	public function __construct($db)
	{
		$this->db = $db;

		$this->name = preg_replace('/^Interface/i', '', get_class($this));
		$this->family = "demo";
		$this->description = "MyModule triggers.";
		// 'development', 'experimental', 'dolibarr' or version
		$this->version = 'development';
		$this->picto = 'mymodule@mymodule';
	}

	/**
	 * Trigger name
	 *
	 * @return string Name of trigger file
	 */
	public function getName()
	{
		return $this->name;
	}

	/**
	 * Trigger description
	 *
	 * @return string Description of trigger file
	 */
	public function getDesc()
	{
		return $this->description;
	}


	/**
	 * Function called when a Dolibarrr business event is done.
	 * All functions "runTrigger" are triggered if file
	 * is inside directory core/triggers
	 *
	 * @param string 		$action 	Event action code
	 * @param CommonObject 	$object 	Object
	 * @param User 			$user 		Object user
	 * @param Translate 	$langs 		Object langs
	 * @param Conf 			$conf 		Object conf
	 * @return int              		<0 if KO, 0 if no triggered ran, >0 if OK
	 */
	public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf)
	{
		// Put here code you want to execute when a Dolibarr business events occurs.
		// Data and type of action are stored into $object and $action

		/** Users */
		if ($action == 'USER_LOGIN') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_UPDATE_SESSION') {
			// Warning: To increase performances, this action is triggered only if
			// constant MAIN_ACTIVATE_UPDATESESSIONTRIGGER is set to 1.
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_CREATE_FROM_CONTACT') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_NEW_PASSWORD') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_ENABLEDISABLE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_LOGOUT') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_SETINGROUP') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'USER_REMOVEFROMGROUP') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Groups */
		} elseif ($action == 'GROUP_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'GROUP_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'GROUP_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Companies */
		} elseif ($action == 'COMPANY_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'COMPANY_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'COMPANY_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Contacts */
		} elseif ($action == 'CONTACT_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTACT_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTACT_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
			// Products
		} elseif ($action == 'PRODUCT_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PRODUCT_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PRODUCT_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Customer orders */
		} elseif ($action == 'ORDER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_CLONE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_BUILDDOC') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_SENTBYMAIL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEORDER_INSERT') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEORDER_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Supplier orders */
		} elseif ($action == 'ORDER_SUPPLIER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_SUPPLIER_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'ORDER_SUPPLIER_SENTBYMAIL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'SUPPLIER_ORDER_BUILDDOC') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Proposals */
		} elseif ($action == 'PROPAL_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_CLONE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_BUILDDOC') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_SENTBYMAIL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_CLOSE_SIGNED') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_CLOSE_REFUSED') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROPAL_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEPROPAL_INSERT') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEPROPAL_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEPROPAL_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Contracts */
		} elseif ($action == 'CONTRACT_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTRACT_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTRACT_ACTIVATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTRACT_CANCEL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTRACT_CLOSE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CONTRACT_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Bills */
		} elseif ($action == 'BILL_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_CLONE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_BUILDDOC') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_SENTBYMAIL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_CANCEL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'BILL_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEBILL_INSERT') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'LINEBILL_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Payments */
		} elseif ($action == 'PAYMENT_CUSTOMER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PAYMENT_SUPPLIER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PAYMENT_ADD_TO_BANK') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PAYMENT_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Interventions */
		} elseif ($action == 'FICHEINTER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'FICHEINTER_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'FICHEINTER_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'FICHEINTER_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Members */
		} elseif ($action == 'MEMBER_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'MEMBER_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'MEMBER_SUBSCRIPTION') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'MEMBER_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'MEMBER_NEW_PASSWORD') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'MEMBER_RESILIATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'MEMBER_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Categories */
		} elseif ($action == 'CATEGORY_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CATEGORY_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'CATEGORY_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Projects */
		} elseif ($action == 'PROJECT_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROJECT_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'PROJECT_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
			/** Project tasks */
		} elseif ($action == 'TASK_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'TASK_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'TASK_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Task time spent */
		} elseif ($action == 'TASK_TIMESPENT_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'TASK_TIMESPENT_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'TASK_TIMESPENT_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** Shipping */
		} elseif ($action == 'SHIPPING_CREATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'SHIPPING_MODIFY') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'SHIPPING_VALIDATE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'SHIPPING_SENTBYMAIL') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'SHIPPING_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'SHIPPING_BUILDDOC') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);

			/** File */
		} elseif ($action == 'FILE_UPLOAD') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		} elseif ($action == 'FILE_DELETE') {
			dol_syslog(
				"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
			);
		}

		return 0;
	}
}


1			<?php
2			/* <one line to give the program's name and a brief idea of what it does.>
3			* Copyright (C) <year> <name of author>
4			*
5			* This program is free software: you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation, either version 3 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License
16			* along with this program. If not, see <http://www.gnu.org/licenses/>.
17			*/
18
19			/**
20			* \file core/triggers/interface_99_modMyModule_Triggers.class.php
21			* \ingroup mymodule
22			* \brief Example trigger.
23			*
24			* Put detailed description here.
25			*
26			* \remarks You can create other triggers by copying this one.
27			* - File name should be either:
28			* - interface_99_modMyModule_MyTrigger.class.php
29			* - interface_99_all_MyTrigger.class.php
30			* - The file must stay in core/triggers
31			* - The class name must be InterfaceMytrigger
32			* - The constructor method must be named InterfaceMytrigger
33			* - The name property name must be MyTrigger
34			*/
35
36			require_once DOL_DOCUMENT_ROOT.'/core/triggers/dolibarrtriggers.class.php';
37
38
39			/**
40			* Class of triggers for MyModule module
41			*/
42			class InterfaceMyModuleTrigger extends DolibarrTriggers
43			{
44			/**
45			* @var DoliDB Database handler
46			*/
47			protected $db;
48
49			/**
50			* Constructor
51			*
52			* @param DoliDB $db Database handler
53			*/
54			public function __construct($db)
55			{
56			$this->db = $db;
57
58			$this->name = preg_replace('/^Interface/i', '', get_class($this));
59			$this->family = "demo";
60			$this->description = "MyModule triggers.";
61			// 'development', 'experimental', 'dolibarr' or version
62			$this->version = 'development';
63			$this->picto = 'mymodule@mymodule';
64			}
65
66			/**
67			* Trigger name
68			*
69			* @return string Name of trigger file
70			*/
71			public function getName()
72			{
73			return $this->name;
74			}
75
76			/**
77			* Trigger description
78			*
79			* @return string Description of trigger file
80			*/
81			public function getDesc()
82			{
83			return $this->description;
84			}
85
86
87			/**
88			* Function called when a Dolibarrr business event is done.
89			* All functions "runTrigger" are triggered if file
90			* is inside directory core/triggers
91			*
92			* @param string $action Event action code
93			* @param CommonObject $object Object
94			* @param User $user Object user
95			* @param Translate $langs Object langs
96			* @param Conf $conf Object conf
97			* @return int <0 if KO, 0 if no triggered ran, >0 if OK
98			*/
99			public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf)
100			{
101			// Put here code you want to execute when a Dolibarr business events occurs.
102			// Data and type of action are stored into $object and $action
103
104			/** Users */
105			if ($action == 'USER_LOGIN') {
106			dol_syslog(
107			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
108			);
109			} elseif ($action == 'USER_UPDATE_SESSION') {
110			// Warning: To increase performances, this action is triggered only if
111			// constant MAIN_ACTIVATE_UPDATESESSIONTRIGGER is set to 1.
112			dol_syslog(
113			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
114			);
115			} elseif ($action == 'USER_CREATE') {
116			dol_syslog(
117			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
118			);
119			} elseif ($action == 'USER_CREATE_FROM_CONTACT') {
120			dol_syslog(
121			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
122			);
123			} elseif ($action == 'USER_MODIFY') {
124			dol_syslog(
125			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
126			);
127			} elseif ($action == 'USER_NEW_PASSWORD') {
128			dol_syslog(
129			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
130			);
131			} elseif ($action == 'USER_ENABLEDISABLE') {
132			dol_syslog(
133			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
134			);
135			} elseif ($action == 'USER_DELETE') {
136			dol_syslog(
137			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
138			);
139			} elseif ($action == 'USER_LOGOUT') {
140			dol_syslog(
141			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
142			);
143			} elseif ($action == 'USER_SETINGROUP') {
144			dol_syslog(
145			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
146			);
147			} elseif ($action == 'USER_REMOVEFROMGROUP') {
148			dol_syslog(
149			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
150			);
151
152			/** Groups */
153			} elseif ($action == 'GROUP_CREATE') {
154			dol_syslog(
155			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
156			);
157			} elseif ($action == 'GROUP_MODIFY') {
158			dol_syslog(
159			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
160			);
161			} elseif ($action == 'GROUP_DELETE') {
162			dol_syslog(
163			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
164			);
165
166			/** Companies */
167			} elseif ($action == 'COMPANY_CREATE') {
168			dol_syslog(
169			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
170			);
171			} elseif ($action == 'COMPANY_MODIFY') {
172			dol_syslog(
173			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
174			);
175			} elseif ($action == 'COMPANY_DELETE') {
176			dol_syslog(
177			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
178			);
179
180			/** Contacts */
181			} elseif ($action == 'CONTACT_CREATE') {
182			dol_syslog(
183			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
184			);
185			} elseif ($action == 'CONTACT_MODIFY') {
186			dol_syslog(
187			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
188			);
189			} elseif ($action == 'CONTACT_DELETE') {
190			dol_syslog(
191			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
192			);
193			// Products
194			} elseif ($action == 'PRODUCT_CREATE') {
195			dol_syslog(
196			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
197			);
198			} elseif ($action == 'PRODUCT_MODIFY') {
199			dol_syslog(
200			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
201			);
202			} elseif ($action == 'PRODUCT_DELETE') {
203			dol_syslog(
204			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
205			);
206
207			/** Customer orders */
208			} elseif ($action == 'ORDER_CREATE') {
209			dol_syslog(
210			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
211			);
212			} elseif ($action == 'ORDER_CLONE') {
213			dol_syslog(
214			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
215			);
216			} elseif ($action == 'ORDER_VALIDATE') {
217			dol_syslog(
218			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
219			);
220			} elseif ($action == 'ORDER_DELETE') {
221			dol_syslog(
222			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
223			);
224			} elseif ($action == 'ORDER_BUILDDOC') {
225			dol_syslog(
226			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
227			);
228			} elseif ($action == 'ORDER_SENTBYMAIL') {
229			dol_syslog(
230			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
231			);
232			} elseif ($action == 'LINEORDER_INSERT') {
233			dol_syslog(
234			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
235			);
236			} elseif ($action == 'LINEORDER_DELETE') {
237			dol_syslog(
238			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
239			);
240
241			/** Supplier orders */
242			} elseif ($action == 'ORDER_SUPPLIER_CREATE') {
243			dol_syslog(
244			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
245			);
246			} elseif ($action == 'ORDER_SUPPLIER_VALIDATE') {
247			dol_syslog(
248			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
249			);
250			} elseif ($action == 'ORDER_SUPPLIER_SENTBYMAIL') {
251			dol_syslog(
252			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
253			);
254			} elseif ($action == 'SUPPLIER_ORDER_BUILDDOC') {
255			dol_syslog(
256			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
257			);
258
259			/** Proposals */
260			} elseif ($action == 'PROPAL_CREATE') {
261			dol_syslog(
262			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
263			);
264			} elseif ($action == 'PROPAL_CLONE') {
265			dol_syslog(
266			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
267			);
268			} elseif ($action == 'PROPAL_MODIFY') {
269			dol_syslog(
270			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
271			);
272			} elseif ($action == 'PROPAL_VALIDATE') {
273			dol_syslog(
274			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
275			);
276			} elseif ($action == 'PROPAL_BUILDDOC') {
277			dol_syslog(
278			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
279			);
280			} elseif ($action == 'PROPAL_SENTBYMAIL') {
281			dol_syslog(
282			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
283			);
284			} elseif ($action == 'PROPAL_CLOSE_SIGNED') {
285			dol_syslog(
286			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
287			);
288			} elseif ($action == 'PROPAL_CLOSE_REFUSED') {
289			dol_syslog(
290			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
291			);
292			} elseif ($action == 'PROPAL_DELETE') {
293			dol_syslog(
294			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
295			);
296			} elseif ($action == 'LINEPROPAL_INSERT') {
297			dol_syslog(
298			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
299			);
300			} elseif ($action == 'LINEPROPAL_MODIFY') {
301			dol_syslog(
302			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
303			);
304			} elseif ($action == 'LINEPROPAL_DELETE') {
305			dol_syslog(
306			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
307			);
308
309			/** Contracts */
310			} elseif ($action == 'CONTRACT_CREATE') {
311			dol_syslog(
312			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
313			);
314			} elseif ($action == 'CONTRACT_MODIFY') {
315			dol_syslog(
316			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
317			);
318			} elseif ($action == 'CONTRACT_ACTIVATE') {
319			dol_syslog(
320			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
321			);
322			} elseif ($action == 'CONTRACT_CANCEL') {
323			dol_syslog(
324			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
325			);
326			} elseif ($action == 'CONTRACT_CLOSE') {
327			dol_syslog(
328			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
329			);
330			} elseif ($action == 'CONTRACT_DELETE') {
331			dol_syslog(
332			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
333			);
334
335			/** Bills */
336			} elseif ($action == 'BILL_CREATE') {
337			dol_syslog(
338			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
339			);
340			} elseif ($action == 'BILL_CLONE') {
341			dol_syslog(
342			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
343			);
344			} elseif ($action == 'BILL_MODIFY') {
345			dol_syslog(
346			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
347			);
348			} elseif ($action == 'BILL_VALIDATE') {
349			dol_syslog(
350			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
351			);
352			} elseif ($action == 'BILL_BUILDDOC') {
353			dol_syslog(
354			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
355			);
356			} elseif ($action == 'BILL_SENTBYMAIL') {
357			dol_syslog(
358			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
359			);
360			} elseif ($action == 'BILL_CANCEL') {
361			dol_syslog(
362			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
363			);
364			} elseif ($action == 'BILL_DELETE') {
365			dol_syslog(
366			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
367			);
368			} elseif ($action == 'LINEBILL_INSERT') {
369			dol_syslog(
370			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
371			);
372			} elseif ($action == 'LINEBILL_DELETE') {
373			dol_syslog(
374			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
375			);
376
377			/** Payments */
378			} elseif ($action == 'PAYMENT_CUSTOMER_CREATE') {
379			dol_syslog(
380			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
381			);
382			} elseif ($action == 'PAYMENT_SUPPLIER_CREATE') {
383			dol_syslog(
384			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
385			);
386			} elseif ($action == 'PAYMENT_ADD_TO_BANK') {
387			dol_syslog(
388			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
389			);
390			} elseif ($action == 'PAYMENT_DELETE') {
391			dol_syslog(
392			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
393			);
394
395			/** Interventions */
396			} elseif ($action == 'FICHEINTER_CREATE') {
397			dol_syslog(
398			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
399			);
400			} elseif ($action == 'FICHEINTER_MODIFY') {
401			dol_syslog(
402			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
403			);
404			} elseif ($action == 'FICHEINTER_VALIDATE') {
405			dol_syslog(
406			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
407			);
408			} elseif ($action == 'FICHEINTER_DELETE') {
409			dol_syslog(
410			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
411			);
412
413			/** Members */
414			} elseif ($action == 'MEMBER_CREATE') {
415			dol_syslog(
416			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
417			);
418			} elseif ($action == 'MEMBER_VALIDATE') {
419			dol_syslog(
420			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
421			);
422			} elseif ($action == 'MEMBER_SUBSCRIPTION') {
423			dol_syslog(
424			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
425			);
426			} elseif ($action == 'MEMBER_MODIFY') {
427			dol_syslog(
428			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
429			);
430			} elseif ($action == 'MEMBER_NEW_PASSWORD') {
431			dol_syslog(
432			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
433			);
434			} elseif ($action == 'MEMBER_RESILIATE') {
435			dol_syslog(
436			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
437			);
438			} elseif ($action == 'MEMBER_DELETE') {
439			dol_syslog(
440			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
441			);
442
443			/** Categories */
444			} elseif ($action == 'CATEGORY_CREATE') {
445			dol_syslog(
446			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
447			);
448			} elseif ($action == 'CATEGORY_MODIFY') {
449			dol_syslog(
450			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
451			);
452			} elseif ($action == 'CATEGORY_DELETE') {
453			dol_syslog(
454			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
455			);
456
457			/** Projects */
458			} elseif ($action == 'PROJECT_CREATE') {
459			dol_syslog(
460			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
461			);
462			} elseif ($action == 'PROJECT_MODIFY') {
463			dol_syslog(
464			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
465			);
466			} elseif ($action == 'PROJECT_DELETE') {
467			dol_syslog(
468			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
469			);
470			/** Project tasks */
471			} elseif ($action == 'TASK_CREATE') {
472			dol_syslog(
473			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
474			);
475			} elseif ($action == 'TASK_MODIFY') {
476			dol_syslog(
477			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
478			);
479			} elseif ($action == 'TASK_DELETE') {
480			dol_syslog(
481			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
482			);
483
484			/** Task time spent */
485			} elseif ($action == 'TASK_TIMESPENT_CREATE') {
486			dol_syslog(
487			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
488			);
489			} elseif ($action == 'TASK_TIMESPENT_MODIFY') {
490			dol_syslog(
491			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
492			);
493			} elseif ($action == 'TASK_TIMESPENT_DELETE') {
494			dol_syslog(
495			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
496			);
497
498			/** Shipping */
499			} elseif ($action == 'SHIPPING_CREATE') {
500			dol_syslog(
501			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
502			);
503			} elseif ($action == 'SHIPPING_MODIFY') {
504			dol_syslog(
505			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
506			);
507			} elseif ($action == 'SHIPPING_VALIDATE') {
508			dol_syslog(
509			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
510			);
511			} elseif ($action == 'SHIPPING_SENTBYMAIL') {
512			dol_syslog(
513			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
514			);
515			} elseif ($action == 'SHIPPING_DELETE') {
516			dol_syslog(
517			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
518			);
519			} elseif ($action == 'SHIPPING_BUILDDOC') {
520			dol_syslog(
521			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
522			);
523
524			/** File */
525			} elseif ($action == 'FILE_UPLOAD') {
526			dol_syslog(
527			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
528			);
529			} elseif ($action == 'FILE_DELETE') {
530			dol_syslog(
531			"Trigger '" . $this->name . "' for action '$action' launched by " . __FILE__ . ". id=" . $object->id
532			);
533			}
534
535			return 0;
536			}
537			}
538

Dolibarr / dolibarr

Branch — develop (59ab9a)

InterfaceMyModuleTrigger::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like