CRM/Contact/Page/SavedSearch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * Main page for viewing all Saved searches.
  36  */
  37 class CRM_Contact_Page_SavedSearch extends CRM_Core_Page {
  38
  39   /**
  40    * The action links that we need to display for the browse screen.
  41    *
  42    * @var array
  43    */
  44   static $_links = NULL;
  45
  46   /**
  47    * Delete a saved search.
  48    *
  49    * @param int $id
  50    *   Id of saved search.
  51    */
  52   public function delete($id) {
  53     // first delete the group associated with this saved search
  54     $group = new CRM_Contact_DAO_Group();
  55     $group->saved_search_id = $id;
  56     if ($group->find(TRUE)) {
  57       CRM_Contact_BAO_Group::discard($group->id);
  58     }
  59
  60     $savedSearch = new CRM_Contact_DAO_SavedSearch();
  61     $savedSearch->id = $id;
  62     $savedSearch->is_active = 0;
  63     $savedSearch->save();
  64   }
  65
  66   /**
  67    * Browse all saved searches.
  68    *
  69    * @return mixed
  70    *   content of the parents run method
  71    */
  72   public function browse() {
  73     $rows = [];
  74
  75     $savedSearch = new CRM_Contact_DAO_SavedSearch();
  76     $savedSearch->is_active = 1;
  77     $savedSearch->selectAdd();
  78     $savedSearch->selectAdd('id, form_values');
  79     $savedSearch->find();
  80     $properties = ['id', 'name', 'description'];
  81     while ($savedSearch->fetch()) {
  82       // get name and description from group object
  83       $group = new CRM_Contact_DAO_Group();
  84       $group->saved_search_id = $savedSearch->id;
  85       if ($group->find(TRUE)) {
  86         $permissions = CRM_Contact_BAO_Group::checkPermission($group->id, TRUE);
  87         if (!CRM_Utils_System::isNull($permissions)) {
  88           $row = [];
  89
  90           $row['name'] = $group->title;
  91           $row['description'] = $group->description;
  92
  93           $row['id'] = $savedSearch->id;
  94           $formValues = unserialize($savedSearch->form_values);
  95           $query = new CRM_Contact_BAO_Query($formValues);
  96           $row['query_detail'] = $query->qill();
  97
  98           $action = array_sum(array_keys(self::links()));
  99           $action = $action & CRM_Core_Action::mask($permissions);
 100           $row['action'] = CRM_Core_Action::formLink(
 101             self::links(),
 102             $action,
 103             ['id' => $row['id']],
 104             ts('more'),
 105             FALSE,
 106             'savedSearch.manage.action',
 107             'SavedSearch',
 108             $row['id']
 109           );
 110
 111           $rows[] = $row;
 112         }
 113       }
 114     }
 115
 116     $this->assign('rows', $rows);
 117     return parent::run();
 118   }
 119
 120   /**
 121    * Run this page (figure out the action needed and perform it).
 122    */
 123   public function run() {
 124     $action = CRM_Utils_Request::retrieve('action', 'String',
 125       $this, FALSE, 'browse'
 126     );
 127
 128     $this->assign('action', $action);
 129
 130     if ($action & CRM_Core_Action::DELETE) {
 131       $id = CRM_Utils_Request::retrieve('id', 'Positive',
 132         $this, TRUE
 133       );
 134       $this->delete($id);
 135     }
 136     $this->browse();
 137   }
 138
 139   /**
 140    * Get action Links.
 141    *
 142    * @return array
 143    *   (reference) of action links
 144    */
 145   public static function &links() {
 146
 147     if (!(self::$_links)) {
 148
 149       $deleteExtra = ts('Do you really want to remove this Smart Group?');
 150
 151       self::$_links = [
 152         CRM_Core_Action::VIEW => [
 153           'name' => ts('Search'),
 154           'url' => 'civicrm/contact/search/advanced',
 155           'qs' => 'reset=1&force=1&ssID=%%id%%',
 156           'title' => ts('Search'),
 157         ],
 158         CRM_Core_Action::DELETE => [
 159           'name' => ts('Delete'),
 160           'url' => 'civicrm/contact/search/saved',
 161           'qs' => 'action=delete&id=%%id%%',
 162           'extra' => 'onclick="return confirm(\'' . $deleteExtra . '\');"',
 163         ],
 164       ];
 165     }
 166     return self::$_links;
 167   }
 168
 169 }