CRM/Utils add comments
[civicrm-core.git] / CRM / Utils / Hook / Soap.php
1 <?php
2
3 /*
4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
10 | |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
19 | |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
27 */
28
29 /**
30 *
31 * @package CiviCRM_Hook
32 * @copyright CiviCRM LLC (c) 2004-2014
33 * $Id: $
34 *
35 */
36 class CRM_Utils_Hook_Soap extends CRM_Utils_Hook {
37 /**
38 *Invoke hooks
39 *
40 * @param int $numParams Number of parameters to pass to the hook
41 * @param mixed $arg1 parameter to be passed to the hook
42 * @param mixed $arg2 parameter to be passed to the hook
43 * @param mixed $arg3 parameter to be passed to the hook
44 * @param mixed $arg4 parameter to be passed to the hook
45 * @param mixed $arg5 parameter to be passed to the hook
46 * @param mixed $arg6 parameter to be passed to the hook
47 * @param string $fnSuffix function suffix, this is effectively the hook name
48 *
49 * @return mixed
50 */
51 /**
52 * @param int $numParams
53 * @param mixed $arg1
54 * @param mixed $arg2
55 * @param mixed $arg3
56 * @param mixed $arg4
57 * @param mixed $arg5
58 * @param mixed $arg6
59 * @param string $fnSuffix
60 *
61 * @return mixed
62 */
63 function invoke($numParams,
64 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
65 $fnSuffix
66 ) {
67 // suppress all hok calls during soap
68 return;
69 }
70 }
71