3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * The Contact Wrapper is a wrapper class which is called by
30 * contact.module after it parses the menu path.
32 * The key elements of the wrapper are the controller and the
33 * run method as explained below.
36 * @copyright CiviCRM LLC (c) 2004-2015
40 class CRM_Utils_Wrapper
{
45 * The controller which will handle the display and processing of this page.
47 protected $_controller;
52 * The heart of the callback processing is done by this method.
53 * forms are of different type and have different operations.
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)
64 public function run($formName, $formLabel = NULL, $arguments = NULL) {
65 if (is_array($arguments)) {
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);
69 $attachUpload = (bool) CRM_Utils_Array
::value('attachUpload', $arguments, FALSE);
70 $ignoreKey = (bool) CRM_Utils_Array
::value('ignoreKey', $arguments, FALSE);
75 $addSequence = $ignoreKey = $imageUpload = $attachUpload = FALSE;
78 $this->_controller
= new CRM_Core_Controller_Simple(
88 if (array_key_exists('urlToSession', $arguments)) {
89 if (is_array($arguments['urlToSession'])) {
90 foreach ($arguments['urlToSession'] as $params) {
91 $urlVar = CRM_Utils_Array
::value('urlVar', $params);
92 $sessionVar = CRM_Utils_Array
::value('sessionVar', $params);
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);
98 $value = CRM_Utils_Request
::retrieve(
105 $this->_controller
->set($sessionVar, $value);
110 if (array_key_exists('setEmbedded', $arguments)) {
111 $this->_controller
->setEmbedded(TRUE);
114 $this->_controller
->process();
115 return $this->_controller
->run();