Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * The Contact Wrapper is a wrapper class which is called by | |
30 | * contact.module after it parses the menu path. | |
31 | * | |
32 | * The key elements of the wrapper are the controller and the | |
33 | * run method as explained below. | |
34 | * | |
35 | * @package CRM | |
e7112fa7 | 36 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
37 | * $Id: $ |
38 | * | |
39 | */ | |
40 | class CRM_Utils_Wrapper { | |
41 | ||
42 | /** | |
fe482240 | 43 | * Simple Controller. |
6a488035 TO |
44 | * |
45 | * The controller which will handle the display and processing of this page. | |
6a488035 TO |
46 | */ |
47 | protected $_controller; | |
48 | ||
49 | /** | |
50 | * Run. | |
51 | * | |
52 | * The heart of the callback processing is done by this method. | |
53 | * forms are of different type and have different operations. | |
54 | * | |
6c552737 TO |
55 | * @param string $formName name of the form processing this action |
56 | * @param string $formLabel label for the above form | |
57 | * @param array $arguments | |
58 | * - int mode: mode of operation. | |
59 | * - bool addSequence: should we add a unique sequence number to the end of the key | |
60 | * - bool ignoreKey: should we not set a qfKey for this controller (for standalone forms) | |
6a488035 | 61 | * |
a6c01b45 | 62 | * @return void |
6001af1f | 63 | */ |
00be9182 | 64 | public function run($formName, $formLabel = NULL, $arguments = NULL) { |
6a488035 | 65 | if (is_array($arguments)) { |
353ffa53 TO |
66 | $mode = CRM_Utils_Array::value('mode', $arguments); |
67 | $imageUpload = (bool) CRM_Utils_Array::value('imageUpload', $arguments, FALSE); | |
68 | $addSequence = (bool) CRM_Utils_Array::value('addSequence', $arguments, FALSE); | |
6a488035 | 69 | $attachUpload = (bool) CRM_Utils_Array::value('attachUpload', $arguments, FALSE); |
353ffa53 | 70 | $ignoreKey = (bool) CRM_Utils_Array::value('ignoreKey', $arguments, FALSE); |
6a488035 TO |
71 | } |
72 | else { | |
353ffa53 TO |
73 | $arguments = array(); |
74 | $mode = NULL; | |
6a488035 TO |
75 | $addSequence = $ignoreKey = $imageUpload = $attachUpload = FALSE; |
76 | } | |
77 | ||
78 | $this->_controller = new CRM_Core_Controller_Simple( | |
79 | $formName, | |
80 | $formLabel, | |
81 | $mode, | |
82 | $imageUpload, | |
83 | $addSequence, | |
84 | $ignoreKey, | |
85 | $attachUpload | |
86 | ); | |
87 | ||
88 | if (array_key_exists('urlToSession', $arguments)) { | |
89 | if (is_array($arguments['urlToSession'])) { | |
90 | foreach ($arguments['urlToSession'] as $params) { | |
353ffa53 | 91 | $urlVar = CRM_Utils_Array::value('urlVar', $params); |
6a488035 | 92 | $sessionVar = CRM_Utils_Array::value('sessionVar', $params); |
353ffa53 TO |
93 | $type = CRM_Utils_Array::value('type', $params); |
94 | $default = CRM_Utils_Array::value('default', $params); | |
95 | $abort = CRM_Utils_Array::value('abort', $params, FALSE); | |
6a488035 TO |
96 | |
97 | $value = NULL; | |
884605ca DL |
98 | $value = CRM_Utils_Request::retrieve( |
99 | $urlVar, | |
6a488035 TO |
100 | $type, |
101 | $this->_controller, | |
102 | $abort, | |
103 | $default | |
104 | ); | |
105 | $this->_controller->set($sessionVar, $value); | |
106 | } | |
107 | } | |
108 | } | |
109 | ||
110 | if (array_key_exists('setEmbedded', $arguments)) { | |
111 | $this->_controller->setEmbedded(TRUE); | |
112 | } | |
113 | ||
114 | $this->_controller->process(); | |
115 | return $this->_controller->run(); | |
116 | } | |
96025800 | 117 | |
6a488035 | 118 | } |