CRM/Utils/Recent.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  *
  39  */
  40 class CRM_Utils_Recent {
  41
  42   /**
  43    * Max number of items in queue
  44    *
  45    * @int
  46    */
  47   const MAX_ITEMS = 10, STORE_NAME = 'CRM_Utils_Recent';
  48
  49   /**
  50    * The list of recently viewed items
  51    *
  52    * @var array
  53    * @static
  54    */
  55   static private $_recent = NULL;
  56
  57   /**
  58    * Initialize this class and set the static variables
  59    *
  60    * @return void
  61    * @static
  62    */
  63   public static function initialize() {
  64     if (!self::$_recent) {
  65       $session = CRM_Core_Session::singleton();
  66       self::$_recent = $session->get(self::STORE_NAME);
  67       if (!self::$_recent) {
  68         self::$_recent = array();
  69       }
  70     }
  71   }
  72
  73   /**
  74    * Return the recently viewed array
  75    *
  76    * @return array the recently viewed array
  77    * @static
  78    */
  79   public static function &get() {
  80     self::initialize();
  81     return self::$_recent;
  82   }
  83
  84   /**
  85    * Add an item to the recent stack
  86    *
  87    * @param string $title the title to display
  88    * @param string $url the link for the above title
  89    * @param string $id object id
  90    * @param $type
  91    * @param int $contactId
  92    * @param string $contactName
  93    * @param array $others
  94    *
  95    * @return void
  96    * @static
  97    */
  98   static function add($title,
  99     $url,
 100     $id,
 101     $type,
 102     $contactId,
 103     $contactName,
 104     $others = array()
 105   ) {
 106     self::initialize();
 107     $session = CRM_Core_Session::singleton();
 108
 109     // make sure item is not already present in list
 110     for ($i = 0; $i < count(self::$_recent); $i++) {
 111       if (self::$_recent[$i]['url'] == $url) {
 112         // delete item from array
 113         array_splice(self::$_recent, $i, 1);
 114         break;
 115       }
 116     }
 117
 118     if (!is_array($others)) {
 119       $others = array();
 120     }
 121
 122     array_unshift(self::$_recent,
 123       array(
 124         'title' => $title,
 125         'url' => $url,
 126         'id' => $id,
 127         'type' => $type,
 128         'contact_id' => $contactId,
 129         'contactName' => $contactName,
 130         'subtype' => CRM_Utils_Array::value('subtype', $others),
 131         'isDeleted' => CRM_Utils_Array::value('isDeleted', $others, FALSE),
 132         'image_url' => CRM_Utils_Array::value('imageUrl', $others),
 133         'edit_url' => CRM_Utils_Array::value('editUrl', $others),
 134         'delete_url' => CRM_Utils_Array::value('deleteUrl', $others),
 135       )
 136     );
 137     if (count(self::$_recent) > self::MAX_ITEMS) {
 138       array_pop(self::$_recent);
 139     }
 140
 141     CRM_Utils_Hook::recent(self::$_recent);
 142
 143     $session->set(self::STORE_NAME, self::$_recent);
 144   }
 145
 146   /**
 147    * Delete an item from the recent stack
 148    *
 149    * @param array $recentItem array of the recent Item to be removed
 150    *
 151    * @return void
 152    * @static
 153    */
 154   public static function del($recentItem) {
 155     self::initialize();
 156     $tempRecent = self::$_recent;
 157
 158     self::$_recent = '';
 159
 160     // make sure item is not already present in list
 161     for ($i = 0; $i < count($tempRecent); $i++) {
 162       if (!($tempRecent[$i]['id'] == $recentItem['id'] &&
 163           $tempRecent[$i]['type'] == $recentItem['type']
 164         )) {
 165         self::$_recent[] = $tempRecent[$i];
 166       }
 167     }
 168
 169     $session = CRM_Core_Session::singleton();
 170     $session->set(self::STORE_NAME, self::$_recent);
 171   }
 172
 173   /**
 174    * Delete an item from the recent stack
 175    *
 176    * @param string $id  contact id that had to be removed
 177    *
 178    * @return void
 179    * @static
 180    */
 181   public static function delContact($id) {
 182     self::initialize();
 183
 184     $tempRecent = self::$_recent;
 185
 186     self::$_recent = '';
 187
 188     // rebuild recent.
 189     for ($i = 0; $i < count($tempRecent); $i++) {
 190       // don't include deleted contact in recent.
 191       if (CRM_Utils_Array::value('contact_id', $tempRecent[$i]) == $id) {
 192         continue;
 193       }
 194       self::$_recent[] = $tempRecent[$i];
 195     }
 196
 197     $session = CRM_Core_Session::singleton();
 198     $session->set(self::STORE_NAME, self::$_recent);
 199   }
 200 }
 201