CRM/Contact/Page/View/UserDashBoard.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * CMS User Dashboard
  38  * This class is used to build User Dashboard
  39  *
  40  */
  41 class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page {
  42   public $_contactId = NULL;
  43
  44   /**
  45    * Always show public groups
  46    * @var bool
  47    */
  48   public $_onlyPublicGroups = TRUE;
  49
  50   public $_edit = TRUE;
  51
  52   /**
  53    * The action links that we need to display for the browse screen
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_links = NULL;
  59
  60   /**
  61    * @throws Exception
  62    */
  63   function __construct() {
  64     parent::__construct();
  65
  66     $check = CRM_Core_Permission::check('access Contact Dashboard');
  67
  68     if (!$check) {
  69       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/dashboard', 'reset=1'));
  70     }
  71
  72     $this->_contactId = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  73
  74     $session = CRM_Core_Session::singleton();
  75     $userID = $session->get('userID');
  76
  77     if (!$this->_contactId) {
  78       $this->_contactId = $userID;
  79     }
  80     elseif ($this->_contactId != $userID) {
  81       if (!CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::VIEW)) {
  82         CRM_Core_Error::fatal(ts('You do not have permission to access this contact.'));
  83       }
  84       if (!CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
  85         $this->_edit = FALSE;
  86       }
  87     }
  88   }
  89
  90   /**
  91    * Heart of the viewing process. The runner gets all the meta data for
  92    * the contact and calls the appropriate type of page to view.
  93    *
  94    * @return void
  95    * @access public
  96    */
  97   function preProcess() {
  98     if (!$this->_contactId) {
  99       CRM_Core_Error::fatal(ts('You must be logged in to view this page.'));
 100     }
 101
 102     list($displayName, $contactImage) = CRM_Contact_BAO_Contact::getDisplayAndImage($this->_contactId);
 103
 104     $this->set('displayName', $displayName);
 105     $this->set('contactImage', $contactImage);
 106
 107     CRM_Utils_System::setTitle(ts('Dashboard - %1', array(1 => $displayName)));
 108
 109     $this->assign('recentlyViewed', FALSE);
 110   }
 111
 112   /**
 113    * Build user dashboard
 114    *
 115    * @return void
 116    * @access public
 117    */
 118   function buildUserDashBoard() {
 119     //build component selectors
 120     $dashboardElements = array();
 121     $config = CRM_Core_Config::singleton();
 122
 123     $this->_userOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 124       'user_dashboard_options'
 125     );
 126
 127     $components = CRM_Core_Component::getEnabledComponents();
 128     $this->assign('contactId', $this->_contactId);
 129     foreach ($components as $name => $component) {
 130       $elem = $component->getUserDashboardElement();
 131       if (!$elem) {
 132         continue;
 133       }
 134
 135       if (!empty($this->_userOptions[$name]) &&
 136         (CRM_Core_Permission::access($component->name) ||
 137           CRM_Core_Permission::check($elem['perm'][0])
 138         )
 139       ) {
 140
 141         $userDashboard = $component->getUserDashboardObject();
 142         $dashboardElements[] = array(
 143           'class' => 'crm-dashboard-' . strtolower($component->name),
 144           'sectionTitle' => $elem['title'],
 145           'templatePath' => $userDashboard->getTemplateFileName(),
 146           'weight' => $elem['weight'],
 147         );
 148         $userDashboard->run();
 149       }
 150     }
 151
 152     if (!empty($this->_userOptions['Permissioned Orgs'])) {
 153       $dashboardElements[] = array(
 154         'class' => 'crm-dashboard-permissionedOrgs',
 155         'templatePath' => 'CRM/Contact/Page/View/RelationshipSelector.tpl',
 156         'sectionTitle' => ts('Your Contacts / Organizations'),
 157         'weight' => 40,
 158       );
 159
 160     }
 161
 162     if (!empty($this->_userOptions['PCP'])) {
 163       $dashboardElements[] = array(
 164         'class' => 'crm-dashboard-pcp',
 165         'templatePath' => 'CRM/Contribute/Page/PcpUserDashboard.tpl',
 166         'sectionTitle' => ts('Personal Campaign Pages'),
 167         'weight' => 40,
 168       );
 169       list($pcpBlock, $pcpInfo) = CRM_PCP_BAO_PCP::getPcpDashboardInfo($this->_contactId);
 170       $this->assign('pcpBlock', $pcpBlock);
 171       $this->assign('pcpInfo', $pcpInfo);
 172     }
 173
 174     if (!empty($this->_userOptions['Assigned Activities'])) {
 175       // Assigned Activities section
 176       $dashboardElements[] = array(
 177         'class' => 'crm-dashboard-assignedActivities',
 178         'templatePath' => 'CRM/Activity/Page/UserDashboard.tpl',
 179         'sectionTitle' => ts('Your Assigned Activities'),
 180         'weight' => 5,
 181       );
 182       $userDashboard = new CRM_Activity_Page_UserDashboard;
 183       $userDashboard->run();
 184     }
 185
 186     usort($dashboardElements, array('CRM_Utils_Sort', 'cmpFunc'));
 187     $this->assign('dashboardElements', $dashboardElements);
 188
 189     // return true when 'Invoices / Credit Notes' checkbox is checked
 190     $this->assign('invoices', $this->_userOptions['Invoices / Credit Notes']);
 191
 192     if (!empty($this->_userOptions['Groups'])) {
 193       $this->assign('showGroup', TRUE);
 194       //build group selector
 195       $gContact = new CRM_Contact_Page_View_UserDashBoard_GroupContact();
 196       $gContact->run();
 197     }
 198     else {
 199       $this->assign('showGroup', FALSE);
 200     }
 201   }
 202
 203   /**
 204    * Perform actions and display for user dashboard
 205    *
 206    * @return void
 207    *
 208    * @access public
 209    */
 210   function run() {
 211     $this->preProcess();
 212     $this->buildUserDashBoard();
 213     return parent::run();
 214   }
 215
 216   /**
 217    * Get action links
 218    *
 219    * @return array (reference) of action links
 220    * @static
 221    */
 222   static
 223   function &links() {
 224     if (!(self::$_links)) {
 225       $disableExtra = ts('Are you sure you want to disable this relationship?');
 226
 227       self::$_links = array(
 228         CRM_Core_Action::UPDATE => array(
 229           'name' => ts('Edit Contact Information'),
 230           'url' => 'civicrm/contact/relatedcontact',
 231           'qs' => 'action=update&reset=1&cid=%%cbid%%&rcid=%%cid%%',
 232           'title' => ts('Edit Relationship'),
 233         ),
 234         CRM_Core_Action::VIEW => array(
 235           'name' => ts('Dashboard'),
 236           'url' => 'civicrm/user',
 237           'qs' => 'reset=1&id=%%cbid%%',
 238           'title' => ts('View Relationship'),
 239         ),
 240       );
 241
 242
 243       if (CRM_Core_Permission::check('access CiviCRM')) {
 244         self::$_links = array_merge(self::$_links, array(
 245           CRM_Core_Action::DISABLE => array(
 246               'name' => ts('Disable'),
 247               'url' => 'civicrm/contact/view/rel',
 248               'qs' => 'action=disable&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%&selectedChild=rel&context=dashboard',
 249               'extra' => 'onclick = "return confirm(\'' . $disableExtra . '\');"',
 250               'title' => ts('Disable Relationship'),
 251             ),
 252           ));
 253       }
 254     }
 255
 256     // call the hook so we can modify it
 257     CRM_Utils_Hook::links('view.contact.userDashBoard',
 258       'Contact',
 259       CRM_Core_DAO::$_nullObject,
 260       self::$_links,
 261       CRM_Core_DAO::$_nullObject,
 262       CRM_Core_DAO::$_nullObject
 263     );
 264     return self::$_links;
 265   }
 266 }