3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 abstract class CRM_Core_Page_Basic
extends CRM_Core_Page
{
38 * Define all the abstract functions here.
42 * Name of the BAO to perform various DB manipulations.
46 abstract protected function getBAOName();
49 * An array of action links.
54 abstract protected function &links();
57 * Name of the edit form class.
61 abstract protected function editForm();
68 abstract protected function editName();
71 * UserContext to pop back to.
74 * Mode that we are in.
78 abstract protected function userContext($mode = NULL);
81 * Get userContext params.
84 * Mode that we are in.
88 public function userContextParams($mode = NULL) {
89 return 'reset=1&action=browse';
93 * Allow objects to be added based on permission.
96 * The id of the object.
98 * The name or title of the object.
101 * permission value if permission is granted, else null
103 public function checkPermission($id, $name) {
104 return CRM_Core_Permission
::EDIT
;
108 * Allows the derived class to add some more state variables to
109 * the controller. By default does nothing, and hence is abstract
111 * @param CRM_Core_Controller $controller
112 * The controller object.
114 public function addValues($controller) {
120 * @param string $title
125 * @return \CRM_Core_Page_Basic
127 public function __construct($title = NULL, $mode = NULL) {
128 parent
::__construct($title, $mode);
132 * Run the basic page (run essentially starts execution for that page).
134 public function run() {
136 // do not see args or pageArgs being used, so we should
137 // consider eliminating them in a future version
138 $n = func_num_args();
139 $args = ($n > 0) ?
func_get_arg(0) : NULL;
140 $pageArgs = ($n > 1) ?
func_get_arg(1) : NULL;
141 $sort = ($n > 2) ?
func_get_arg(2) : NULL;
142 // what action do we want to perform ? (store it for smarty too.. :)
144 $id = $this->getIdAndAction();
146 if ($this->_action
& (CRM_Core_Action
::VIEW |
147 CRM_Core_Action
::ADD |
148 CRM_Core_Action
::UPDATE |
149 CRM_Core_Action
::COPY |
150 CRM_Core_Action
::ENABLE |
151 CRM_Core_Action
::DISABLE |
152 CRM_Core_Action
::DELETE
155 // use edit form for view, add or update or delete
156 $this->edit($this->_action
, $id);
159 // if no action or browse
160 $this->browse(NULL, $sort);
163 return parent
::run();
167 * Retrieve the action and ID from the request.
169 * Action is assigned to the template while we're at it. This is pulled from
170 * the `run()` method above.
173 * The ID if present, or 0.
174 * @throws \CRM_Core_Exception
176 public function getIdAndAction() {
177 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
178 $this->assign('action', $this->_action
);
180 $this->assign('selectedChild', CRM_Utils_Request
::retrieve('selectedChild', 'Alphanumeric', $this));
182 // get 'id' if present
183 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, 0);
185 require_once str_replace('_', DIRECTORY_SEPARATOR
, $this->getBAOName()) . ".php";
188 if (!$this->checkPermission($id, NULL)) {
189 CRM_Core_Error
::fatal(ts('You do not have permission to make changes to the record'));
199 public function superRun() {
200 return parent
::run();
204 * Browse all entities.
206 public function browse() {
207 $n = func_num_args();
208 $action = ($n > 0) ?
func_get_arg(0) : NULL;
209 $sort = ($n > 0) ?
func_get_arg(1) : NULL;
210 $links = &$this->links();
211 if ($action == NULL) {
212 if (!empty($links)) {
213 $action = array_sum(array_keys($links));
216 if ($action & CRM_Core_Action
::DISABLE
) {
217 $action -= CRM_Core_Action
::DISABLE
;
219 if ($action & CRM_Core_Action
::ENABLE
) {
220 $action -= CRM_Core_Action
::ENABLE
;
222 $baoString = $this->getBAOName();
223 $object = new $baoString();
227 // lets make sure we get the stuff sorted by name if it exists
228 $fields = &$object->fields();
230 if (!empty($fields['title'])) {
233 elseif (!empty($fields['label'])) {
236 elseif (!empty($fields['name'])) {
241 $object->orderBy($sort);
244 $object->orderBy($key . ' asc');
247 $contactTypes = CRM_Contact_BAO_ContactType
::getSelectElements(FALSE, FALSE);
250 while ($object->fetch()) {
251 if (!isset($object->mapping_type_id
) ||
252 // "1 for Search Builder"
253 $object->mapping_type_id
!= 1
255 $permission = CRM_Core_Permission
::EDIT
;
257 $permission = $this->checkPermission($object->id
, $object->$key);
260 $values[$object->id
] = [];
261 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
263 if (is_a($object, 'CRM_Contact_DAO_RelationshipType')) {
264 if (isset($values[$object->id
]['contact_type_a'])) {
265 $values[$object->id
]['contact_type_a_display'] = $contactTypes[$values[$object->id
]['contact_type_a']];
267 if (isset($values[$object->id
]['contact_type_b'])) {
268 $values[$object->id
]['contact_type_b_display'] = $contactTypes[$values[$object->id
]['contact_type_b']];
272 // populate action links
273 $this->action($object, $action, $values[$object->id
], $links, $permission);
275 if (isset($object->mapping_type_id
)) {
276 $mappintTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Mapping', 'mapping_type_id');
277 $values[$object->id
]['mapping_type'] = $mappintTypes[$object->mapping_type_id
];
282 $this->assign('rows', $values);
286 * Given an object, get the actions that can be associated with this
287 * object. Check the is_active and is_required flags to display valid
290 * @param CRM_Core_DAO $object
291 * The object being considered.
293 * The base set of actions.
294 * @param array $values
295 * The array of values that we send to the template.
296 * @param array $links
297 * The array of links.
298 * @param string $permission
299 * The permission assigned to this object.
301 * @param bool $forceAction
303 public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
304 $values['class'] = '';
305 $newAction = $action;
306 $hasDelete = $hasDisable = TRUE;
308 if (!empty($values['name']) && in_array($values['name'], [
313 static $caseCount = NULL;
314 if (!isset($caseCount)) {
315 $caseCount = CRM_Case_BAO_Case
::caseCount(NULL, FALSE);
317 if ($caseCount > 0) {
318 $hasDelete = $hasDisable = FALSE;
322 $object_type = get_class($object);
325 if (array_key_exists('is_reserved', $object) && $object->is_reserved
) {
326 $values['class'] = 'reserved';
327 // check if object is relationship type
330 'CRM_Contact_BAO_RelationshipType',
331 'CRM_Core_BAO_LocationType',
332 'CRM_Badge_BAO_Layout',
335 if (in_array($object_type, $exceptions)) {
336 $newAction = CRM_Core_Action
::VIEW + CRM_Core_Action
::UPDATE
;
340 $values['action'] = '';
345 if (array_key_exists('is_active', $object)) {
346 if ($object->is_active
) {
348 $newAction +
= CRM_Core_Action
::DISABLE
;
352 $newAction +
= CRM_Core_Action
::ENABLE
;
358 //CRM-4418, handling edit and delete separately.
359 $permissions = [$permission];
360 if ($hasDelete && ($permission == CRM_Core_Permission
::EDIT
)) {
361 //previously delete was subset of edit
362 //so for consistency lets grant delete also.
363 $permissions[] = CRM_Core_Permission
::DELETE
;
366 // make sure we only allow those actions that the user is permissioned for
367 $newAction = $newAction & CRM_Core_Action
::mask($permissions);
369 $values['action'] = CRM_Core_Action
::formLink(
372 ['id' => $object->id
],
375 "basic.$object_type.page",
385 * What mode for the form ?.
387 * Id of the entity (for update, view operations).
389 * @param bool $imageUpload
390 * @param bool $pushUserContext
392 public function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
393 $controller = new CRM_Core_Controller_Simple($this->editForm(),
399 // set the userContext stack
400 if ($pushUserContext) {
401 $session = CRM_Core_Session
::singleton();
402 $session->pushUserContext(CRM_Utils_System
::url($this->userContext($mode), $this->userContextParams($mode)));
405 $controller->set('id', $id);
407 $controller->set('BAOName', $this->getBAOName());
408 $this->addValues($controller);
409 $controller->setEmbedded(TRUE);
410 $controller->process();