+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* The basic state element. Each state element is linked to a form and
* things like going back / stepping forward / process etc
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
class CRM_Core_State {
/**
- * State name
+ * State name.
* @var string
*/
protected $_name;
protected $_type;
/**
- * The state that precedes this state
+ * The state that precedes this state.
* @var CRM_Core_State
*/
protected $_back;
/**
- * The state that succeeds this state
+ * The state that succeeds this state.
* @var CRM_Core_State
*/
protected $_next;
/**
- * The state machine that this state is part of
+ * The state machine that this state is part of.
* @var CRM_Core_StateMachine
*/
protected $_stateMachine;
const START = 1, FINISH = 2, SIMPLE = 4;
/**
- * Constructor
+ * Constructor.
*
* @param string $name
* Internal name of the state.
/**
* Given an CRM Form, jump to the previous page
*
- * @param object the CRM_Core_Form element under consideration
- *
* @return mixed
* does a jump to the back state
*/
/**
* Given an CRM Form, jump to the next page
*
- * @param object the CRM_Core_Form element under consideration
- *
* @return mixed
* does a jump to the nextstate
*/
* Mark this page as valid for the QFC framework. This is needed as
* we build more advanced functionality into the StateMachine
*
- * @param object the QFC data container
- *
* @return void
*/
public function validate(&$data) {
* Mark this page as invalid for the QFC framework. This is needed as
* we build more advanced functionality into the StateMachine
*
- * @param object the QFC data container
- *
* @return void
*/
public function invalidate(&$data) {
}
/**
- * Getter for name
+ * Getter for name.
*
* @return string
*/
}
/**
- * Setter for name
- *
- * @param string
+ * Setter for name.
*
* @return void
*/
}
/**
- * Getter for type
+ * Getter for type.
*
* @return int
*/
public function getType() {
return $this->_type;
}
+
}