CRM/Activity/Controller/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   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  * This class is used by the Search functionality.
  37  *
  38  *  - the search controller is used for building/processing multiform
  39  *    searches.
  40  *
  41  * Typically the first form will display the search criteria and it's results
  42  *
  43  * The second form is used to process search results with the associated actions
  44  *
  45  */
  46 class CRM_Activity_Controller_Search extends CRM_Core_Controller {
  47
  48   /**
  49    * Class constructor.
  50    *
  51    * @param null $title
  52    * @param bool $modal
  53    * @param int|mixed|null $action
  54    */
  55   public function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) {
  56
  57     parent::__construct($title, $modal);
  58
  59     $this->_stateMachine = new CRM_Activity_StateMachine_Search($this, $action);
  60
  61     // Create and instantiate the pages.
  62     $this->addPages($this->_stateMachine, $action);
  63
  64     // Add all the actions.
  65     $this->addActions();
  66   }
  67
  68   /**
  69    * Getter for selectorName.
  70    *
  71    * @return mixed
  72    */
  73   public function selectorName() {
  74     return $this->get('selectorName');
  75   }
  76
  77 }