133 lines
4.5 KiB
PHP
133 lines
4.5 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM 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 Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* @package CiviCRM_Hook
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
|
*/
|
|
class CRM_Utils_Hook_UnitTests extends CRM_Utils_Hook {
|
|
|
|
protected $mockObject;
|
|
|
|
/**
|
|
* @var array $adhocHooks to call
|
|
*/
|
|
protected $adhocHooks;
|
|
protected $civiModules = NULL;
|
|
|
|
/**
|
|
* Call this in CiviUnitTestCase::setUp()
|
|
*/
|
|
public function reset() {
|
|
$this->mockObject = NULL;
|
|
$this->adhocHooks = array();
|
|
}
|
|
|
|
/**
|
|
* Use a unit-testing mock object to handle hook invocations.
|
|
*
|
|
* e.g. hook_civicrm_foo === $mockObject->foo()
|
|
* Mocks with a magic `__call()` method are called for every hook invokation.
|
|
*
|
|
* @param object $mockObject
|
|
*/
|
|
public function setMock($mockObject) {
|
|
$this->mockObject = $mockObject;
|
|
}
|
|
|
|
/**
|
|
* Register a function to run when invoking a specific hook.
|
|
* @param string $hook
|
|
* Hook name, e.g civicrm_pre.
|
|
* @param array $callable
|
|
* Function to call ie array(class, method).
|
|
* eg. array($this, mymethod)
|
|
*/
|
|
public function setHook($hook, $callable) {
|
|
$this->adhocHooks[$hook] = $callable;
|
|
}
|
|
|
|
/**
|
|
* Invoke standard, mock and ad hoc hooks.
|
|
*
|
|
* @param int $numParams
|
|
* Number of parameters to pass to the hook.
|
|
* @param mixed $arg1
|
|
* Parameter to be passed to the hook.
|
|
* @param mixed $arg2
|
|
* Parameter to be passed to the hook.
|
|
* @param mixed $arg3
|
|
* Parameter to be passed to the hook.
|
|
* @param mixed $arg4
|
|
* Parameter to be passed to the hook.
|
|
* @param mixed $arg5
|
|
* Parameter to be passed to the hook.
|
|
* @param mixed $arg6
|
|
* Parameter to be passed to the hook.
|
|
* @param string $fnSuffix
|
|
* Function suffix, this is effectively the hook name.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function invokeViaUF(
|
|
$numParams,
|
|
&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
|
|
$fnSuffix) {
|
|
$params = array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6);
|
|
|
|
$fResult1 = $fResult2 = $fResult3 = NULL;
|
|
|
|
// run standard hooks
|
|
if ($this->civiModules === NULL) {
|
|
$this->civiModules = array();
|
|
$this->requireCiviModules($this->civiModules);
|
|
}
|
|
$fResult1 = $this->runHooks($this->civiModules, $fnSuffix, $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
|
|
|
|
// run mock object hooks
|
|
if ($this->mockObject && is_callable(array($this->mockObject, $fnSuffix))) {
|
|
$fResult2 = call_user_func(array($this->mockObject, $fnSuffix), $arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
|
|
}
|
|
|
|
// run adhoc hooks
|
|
if (!empty($this->adhocHooks[$fnSuffix])) {
|
|
$fResult3 = call_user_func_array($this->adhocHooks[$fnSuffix], $params);
|
|
}
|
|
|
|
$result = array();
|
|
foreach (array($fResult1, $fResult2, $fResult3) as $fResult) {
|
|
if (!empty($fResult) && is_array($fResult)) {
|
|
$result = array_merge($result, $fResult);
|
|
}
|
|
}
|
|
|
|
return empty($result) ? TRUE : $result;
|
|
}
|
|
|
|
}
|