CRM-15928. Rename variable to be more descriptive, update inline docs.
[civicrm-core.git] / CRM / Profile / Page / Router.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2016
32 * $Id$
33 *
34 */
35
36 /**
37 * This is some kind of special-purpose router/front-controller for the various profile URLs.
38 */
39 class CRM_Profile_Page_Router extends CRM_Core_Page {
40
41 /**
42 * This is some kind of special-purpose router/front-controller for the various profile URLs.
43 *
44 * @param array $args
45 * this array contains the arguments of the url.
46 *
47 * @return string|void
48 */
49 public function run($args = NULL) {
50 if ($args[1] !== 'profile') {
51 return NULL;
52 }
53
54 $secondArg = CRM_Utils_Array::value(2, $args, '');
55
56 if ($secondArg == 'map') {
57 $controller = new CRM_Core_Controller_Simple(
58 'CRM_Contact_Form_Task_Map',
59 ts('Map Contact'),
60 NULL, FALSE, FALSE, TRUE
61 );
62
63 $gids = explode(',', CRM_Utils_Request::retrieve('gid', 'String', CRM_Core_DAO::$_nullObject, FALSE, 0, 'GET'));
64
65 if (count($gids) > 1) {
66 foreach ($gids as $pfId) {
67 $profileIds[] = CRM_Utils_Type::escape($pfId, 'Positive');
68 }
69 $controller->set('gid', $profileIds[0]);
70 $profileGID = $profileIds[0];
71 }
72 else {
73 $profileGID = CRM_Utils_Request::retrieve('gid', 'Integer', $controller, TRUE);
74 }
75
76 // make sure that this profile enables mapping
77 // CRM-8609
78 $isMap = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileGID, 'is_map');
79 if (!$isMap) {
80 CRM_Core_Error::statusBounce(ts('This profile does not have the map feature turned on.'));
81 }
82
83 $profileView = CRM_Utils_Request::retrieve('pv', 'Integer', $controller, FALSE);
84
85 // set the userContext stack
86 $session = CRM_Core_Session::singleton();
87 if ($profileView) {
88 $session->pushUserContext(CRM_Utils_System::url('civicrm/profile/view'));
89 }
90 else {
91 $session->pushUserContext(CRM_Utils_System::url('civicrm/profile', 'force=1'));
92 }
93
94 $controller->set('profileGID', $profileGID);
95 $controller->process();
96 return $controller->run();
97 }
98
99 if ($secondArg == 'edit' || $secondArg == 'create') {
100 if ($secondArg == 'edit') {
101 $allowRemoteSubmit = Civi::settings()->get('remote_profile_submissions_allowed');
102 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Edit',
103 ts('Create Profile'),
104 CRM_Core_Action::UPDATE,
105 FALSE, FALSE, $allowRemoteSubmit
106 );
107 $controller->set('edit', 1);
108 $controller->process();
109 return $controller->run();
110 }
111 else {
112 $wrapper = new CRM_Utils_Wrapper();
113 return $wrapper->run('CRM_Profile_Form_Edit',
114 ts('Create Profile'),
115 array(
116 'mode' => CRM_Core_Action::ADD,
117 'ignoreKey' => $allowHtmlSnippet,
118 )
119 );
120 }
121 }
122
123 if ($secondArg == 'view' || empty($secondArg)) {
124 $page = new CRM_Profile_Page_Listings();
125 return $page->run();
126 }
127
128 CRM_Utils_System::permissionDenied();
129 }
130
131 }