CRM/Contact/Page/View/UserDashBoard.php

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