<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.6 |
+ | CiviCRM version 4.7 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
*/
-
-
-
-
abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
protected $_action;
/**
- * Define all the abstract functions here
+ * Define all the abstract functions here.
*/
/**
- * Name of the BAO to perform various DB manipulations
+ * Name of the BAO to perform various DB manipulations.
*
* @return string
*/
-
- abstract function getBAOName();
+ abstract protected function getBAOName();
/**
- * An array of action links
+ * An array of action links.
*
- * @return array (reference)
+ * @return array
+ * (reference)
*/
- abstract function &links();
+ abstract protected function &links();
/**
- * Name of the edit form class
+ * Name of the edit form class.
*
* @return string
*/
- abstract function editForm();
+ abstract protected function editForm();
/**
- * Name of the form
+ * Name of the form.
*
* @return string
*/
- abstract function editName();
+ abstract protected function editName();
/**
- * UserContext to pop back to
+ * UserContext to pop back to.
*
* @param int $mode
* Mode that we are in.
*
* @return string
*/
- abstract function userContext($mode = NULL);
+ abstract protected function userContext($mode = NULL);
/**
- * Get userContext params
+ * Get userContext params.
*
* @param int $mode
* Mode that we are in.
}
/**
- * Allow objects to be added based on permission
+ * Allow objects to be added based on permission.
*
* @param int $id
* The id of the object.
* @param int $name
* The name or title of the object.
*
- * @return string permission value if permission is granted, else null
+ * @return string
+ * permission value if permission is granted, else null
*/
public function checkPermission($id, $name) {
return CRM_Core_Permission::EDIT;
*
* @param CRM_Core_Controller $controller
* The controller object.
- *
- * @return void
*/
- public function addValues($controller) {}
+ public function addValues($controller) {
+ }
/**
- * Class constructor
+ * Class constructor.
*
* @param string $title
* Title of the page.
/**
* Run the basic page (run essentially starts execution for that page).
- *
- * @return void
*/
public function run() {
// CRM-9034
- // dont see args or pageArgs being used, so we should
+ // do not see args or pageArgs being used, so we should
// consider eliminating them in a future version
- $n = func_num_args();
- $args = ($n > 0) ? func_get_arg(0) : NULL;
+ $n = func_num_args();
+ $args = ($n > 0) ? func_get_arg(0) : NULL;
$pageArgs = ($n > 1) ? func_get_arg(1) : NULL;
- $sort = ($n > 2) ? func_get_arg(2) : NULL;
+ $sort = ($n > 2) ? func_get_arg(2) : NULL;
// what action do we want to perform ? (store it for smarty too.. :)
$this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
// get 'id' if present
$id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
- require_once (str_replace('_', DIRECTORY_SEPARATOR, $this->getBAOName()) . ".php");
+ require_once str_replace('_', DIRECTORY_SEPARATOR, $this->getBAOName()) . ".php";
if ($id) {
if (!$this->checkPermission($id, NULL)) {
}
}
- if ($this->_action &
- (CRM_Core_Action::VIEW |
+ if ($this->_action & (CRM_Core_Action::VIEW |
CRM_Core_Action::ADD |
CRM_Core_Action::UPDATE |
CRM_Core_Action::COPY |
/**
* Browse all entities.
- *
- * @return void
*/
public function browse() {
- $n = func_num_args();
+ $n = func_num_args();
$action = ($n > 0) ? func_get_arg(0) : NULL;
- $sort = ($n > 0) ? func_get_arg(1) : NULL;
- $links = &$this->links();
+ $sort = ($n > 0) ? func_get_arg(1) : NULL;
+ $links = &$this->links();
if ($action == NULL) {
if (!empty($links)) {
$action = array_sum(array_keys($links));
$values = array();
- /*
- * lets make sure we get the stuff sorted by name if it exists
- */
-
+ // lets make sure we get the stuff sorted by name if it exists
$fields = &$object->fields();
$key = '';
if (!empty($fields['title'])) {
* The permission assigned to this object.
*
* @param bool $forceAction
- *
- * @return void
*/
public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
$values['class'] = '';
- $newAction = $action;
- $hasDelete = $hasDisable = TRUE;
+ $newAction = $action;
+ $hasDelete = $hasDisable = TRUE;
if (!empty($values['name']) && in_array($values['name'], array(
- 'encounter_medium', 'case_type', 'case_status'))) {
+ 'encounter_medium',
+ 'case_type',
+ 'case_status',
+ ))
+ ) {
static $caseCount = NULL;
if (!isset($caseCount)) {
$caseCount = CRM_Case_BAO_Case::caseCount(NULL, FALSE);
*
* @param bool $imageUpload
* @param bool $pushUserContext
- *
- * @return void
*/
public function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
$controller = new CRM_Core_Controller_Simple($this->editForm(),
$controller->process();
$controller->run();
}
+
}
projects / civicrm-core.git / blobdiff