Merge remote-tracking branch 'upstream/4.4' into 4.4-4.5-2014-09-29-14-51-22

[civicrm-core.git] / CRM / Activity / StateMachine / Search.php

diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php
index 695ad7ca5a1f8fdb0634fcfdbbedb8851d32a8cc..ad14391ecdb9a711316851283d19fa8360c15d0d 100644 (file)
--- a/CRM/Activity/StateMachine/Search.php
+++ b/CRM/Activity/StateMachine/Search.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,7 +27,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -72,6 +72,8 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
    *
    * @param CRM_Core_Controller $controller the controller object
    *
+   * @param string $formName
+   *
    * @return string the name of the form that will handle the task
    * @access protected
    */
@@ -95,6 +97,18 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
     return CRM_Utils_String::getClassName($this->_task);
   }
 
+  /**
+   * Should the controller reset the session
+   * In some cases, specifically search we want to remember
+   * state across various actions and want to go back to the
+   * beginning from the final state, but retain the same session
+   * values
+   *
+   * @return boolean
+   */
+  /**
+   * @return bool
+   */
   function shouldReset() {
     return FALSE;
   }