3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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.
175 public function getIdAndAction() {
176 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
177 $this->assign('action', $this->_action
);
179 // get 'id' if present
180 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, 0);
182 require_once str_replace('_', DIRECTORY_SEPARATOR
, $this->getBAOName()) . ".php";
185 if (!$this->checkPermission($id, NULL)) {
186 CRM_Core_Error
::fatal(ts('You do not have permission to make changes to the record'));
196 public function superRun() {
197 return parent
::run();
201 * Browse all entities.
203 public function browse() {
204 $n = func_num_args();
205 $action = ($n > 0) ?
func_get_arg(0) : NULL;
206 $sort = ($n > 0) ?
func_get_arg(1) : NULL;
207 $links = &$this->links();
208 if ($action == NULL) {
209 if (!empty($links)) {
210 $action = array_sum(array_keys($links));
213 if ($action & CRM_Core_Action
::DISABLE
) {
214 $action -= CRM_Core_Action
::DISABLE
;
216 if ($action & CRM_Core_Action
::ENABLE
) {
217 $action -= CRM_Core_Action
::ENABLE
;
219 $baoString = $this->getBAOName();
220 $object = new $baoString();
224 // lets make sure we get the stuff sorted by name if it exists
225 $fields = &$object->fields();
227 if (!empty($fields['title'])) {
230 elseif (!empty($fields['label'])) {
233 elseif (!empty($fields['name'])) {
238 $object->orderBy($sort);
241 $object->orderBy($key . ' asc');
244 $contactTypes = CRM_Contact_BAO_ContactType
::getSelectElements(FALSE, FALSE);
247 while ($object->fetch()) {
248 if (!isset($object->mapping_type_id
) ||
249 // "1 for Search Builder"
250 $object->mapping_type_id
!= 1
252 $permission = CRM_Core_Permission
::EDIT
;
254 $permission = $this->checkPermission($object->id
, $object->$key);
257 $values[$object->id
] = array();
258 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
260 if (is_a($object, 'CRM_Contact_DAO_RelationshipType')) {
261 if (isset($values[$object->id
]['contact_type_a'])) {
262 $values[$object->id
]['contact_type_a_display'] = $contactTypes[$values[$object->id
]['contact_type_a']];
264 if (isset($values[$object->id
]['contact_type_b'])) {
265 $values[$object->id
]['contact_type_b_display'] = $contactTypes[$values[$object->id
]['contact_type_b']];
269 // populate action links
270 $this->action($object, $action, $values[$object->id
], $links, $permission);
272 if (isset($object->mapping_type_id
)) {
273 $mappintTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Mapping', 'mapping_type_id');
274 $values[$object->id
]['mapping_type'] = $mappintTypes[$object->mapping_type_id
];
279 $this->assign('rows', $values);
283 * Given an object, get the actions that can be associated with this
284 * object. Check the is_active and is_required flags to display valid
287 * @param CRM_Core_DAO $object
288 * The object being considered.
290 * The base set of actions.
291 * @param array $values
292 * The array of values that we send to the template.
293 * @param array $links
294 * The array of links.
295 * @param string $permission
296 * The permission assigned to this object.
298 * @param bool $forceAction
300 public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
301 $values['class'] = '';
302 $newAction = $action;
303 $hasDelete = $hasDisable = TRUE;
305 if (!empty($values['name']) && in_array($values['name'], array(
310 static $caseCount = NULL;
311 if (!isset($caseCount)) {
312 $caseCount = CRM_Case_BAO_Case
::caseCount(NULL, FALSE);
314 if ($caseCount > 0) {
315 $hasDelete = $hasDisable = FALSE;
320 if (array_key_exists('is_reserved', $object) && $object->is_reserved
) {
321 $values['class'] = 'reserved';
322 // check if object is relationship type
323 $object_type = get_class($object);
326 'CRM_Contact_BAO_RelationshipType',
327 'CRM_Core_BAO_LocationType',
328 'CRM_Badge_BAO_Layout',
331 if (in_array($object_type, $exceptions)) {
332 $newAction = CRM_Core_Action
::VIEW + CRM_Core_Action
::UPDATE
;
336 $values['action'] = '';
341 if (array_key_exists('is_active', $object)) {
342 if ($object->is_active
) {
344 $newAction +
= CRM_Core_Action
::DISABLE
;
348 $newAction +
= CRM_Core_Action
::ENABLE
;
354 //CRM-4418, handling edit and delete separately.
355 $permissions = array($permission);
356 if ($hasDelete && ($permission == CRM_Core_Permission
::EDIT
)) {
357 //previously delete was subset of edit
358 //so for consistency lets grant delete also.
359 $permissions[] = CRM_Core_Permission
::DELETE
;
362 // make sure we only allow those actions that the user is permissioned for
363 $newAction = $newAction & CRM_Core_Action
::mask($permissions);
365 $values['action'] = CRM_Core_Action
::formLink($links, $newAction, array('id' => $object->id
));
372 * What mode for the form ?.
374 * Id of the entity (for update, view operations).
376 * @param bool $imageUpload
377 * @param bool $pushUserContext
379 public function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
380 $controller = new CRM_Core_Controller_Simple($this->editForm(),
386 // set the userContext stack
387 if ($pushUserContext) {
388 $session = CRM_Core_Session
::singleton();
389 $session->pushUserContext(CRM_Utils_System
::url($this->userContext($mode), $this->userContextParams($mode)));
392 $controller->set('id', $id);
394 $controller->set('BAOName', $this->getBAOName());
395 $this->addValues($controller);
396 $controller->setEmbedded(TRUE);
397 $controller->process();