DataProcessorContactSearch.php

<?php
/**
 * @author Jaap Jansma <jaap.jansma@civicoop.org>
 * @license AGPL-3.0
 */

/**
 * This class is used by the Search functionality.
 *
 *  - the search controller is used for building/processing multiform
 *    searches.
 *
 * Typically the first form will display the search criteria and it's results
 *
 * The second form is used to process search results with the associated actions.
 */
class CRM_Contact_Controller_DataProcessorContactSearch extends CRM_Core_Controller {

  protected $dataProcessor;

  /**
   * Setter function to set the data porcessor
   *
   * @param $dataProcessorName
   * @param $dataProcessor
   */
  public function setDataProcessor($dataProcessorName, $dataProcessor) {
    $this->dataProcessor = $dataProcessor;
  }

  /**
   * Class constructor.
   *
   * @param string $title
   * @param bool $modal
   * @param int|mixed|null $action
   */
  public function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) {
    parent::__construct($title, $modal);

    $this->_stateMachine = new CRM_Contact_StateMachine_DataProcessorContactSearch($this, $action);

    // create and instantiate the pages
    $this->addPages($this->_stateMachine, $action);
    $this->set('entity', 'Contact');

    // add all the actions
    $this->addActions();
  }

  /**
   * Process the request, overrides the default QFC run method
   * This routine actually checks if the QFC is modal and if it
   * is the first invalid page, if so it call the requested action
   * if not, it calls the display action on the first invalid page
   * avoids the issue of users hitting the back button and getting
   * a broken page
   *
   * This run is basically a composition of the original run and the
   * jump action
   *
   * @return mixed
   */
  public function run() {

    $actionName = $this->getActionName();
    list($pageName, $action) = $actionName;
    // Hack to replace to userContext for redirecting after a Task has been completed.
    // We want the redirect
    if (!$this->_pages[$pageName] instanceof CRM_DataprocessorSearch_Form_ContactSearch) {
      CRM_DataprocessorSearch_Form_Search_Custom_DataprocessorSmartGroupIntegration::setDataProcessorAndFormValues('contact_search', $this->get('formValues'), CRM_Utils_System::currentPath());
      $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
      $urlPath = CRM_Utils_System::currentPath();
      $urlParams = 'force=1';
      if ($qfKey) {
        $urlParams .= "&qfKey=$qfKey";
      }
      $this->setDestination(CRM_Utils_System::url($urlPath, $urlParams));
    }

    return parent::run();
  }

  /**
   * @return mixed
   */
  public function selectorName() {
    return 'CRM_Contact_Selector_DataProcessorContactSearch';
  }

  /**
   * @param string $name
   * @param bool $addSequence
   * @param bool $ignoreKey
   *
   * @return mixed|string
   */
  public function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
    $config = CRM_Core_Config::singleton();

    if (
      $ignoreKey ||
      (isset($config->keyDisable) && $config->keyDisable)
    ) {
      return NULL;
    }

    $key = CRM_Utils_Array::value('qfKey', $_REQUEST, NULL);
    if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
      $key = CRM_Core_Key::get($name, $addSequence);
    }
    else if (!$_SERVER['REQUEST_METHOD'] === 'POST' || !isset($_REQUEST['ssId'])) {
      $_key = CRM_Core_Key::validate($key, $name, $addSequence);
    }
    if (!$key) {
      $this->invalidKey();
    }

    $this->_key = $key;

    return $key;
  }

}