+--------------------------------------------------------------------+
| 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
- * @param int $type state type
- * @param CRM_Core_State $back state that precedes this state
- * @param CRM_Core_State $next state that follows this state
- * @param CRM_Core_StateMachine $stateMachine statemachine that this states belongs to
+ * @param string $name
+ * Internal name of the state.
+ * @param int $type
+ * State type.
+ * @param CRM_Core_State $back
+ * State that precedes this state.
+ * @param CRM_Core_State $next
+ * State that follows this state.
+ * @param CRM_Core_StateMachine $stateMachine
+ * Statemachine that this states belongs to.
*
* @return CRM_Core_State
- * @access public
*/
- function __construct($name, $type, $back, $next, &$stateMachine) {
+ public function __construct($name, $type, $back, $next, &$stateMachine) {
$this->_name = $name;
$this->_type = $type;
$this->_back = $back;
$this->_stateMachine = &$stateMachine;
}
- function debugPrint() {
+ public function debugPrint() {
CRM_Core_Error::debug("{$this->_name}, {$this->_type}", "{$this->_back}, {$this->_next}");
}
/**
* 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
- * @access public
+ * @return mixed
+ * does a jump to the back state
*/
- function handleBackState(&$page) {
+ public function handleBackState(&$page) {
if ($this->_type & self::START) {
$page->handle('display');
}
/**
* 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
- * @access public
+ * @return mixed
+ * does a jump to the nextstate
*/
- function handleNextState(&$page) {
+ public function handleNextState(&$page) {
if ($this->_type & self::FINISH) {
$page->handle('process');
}
* to display the navigation labels or potential path
*
* @return string
- * @access public
*/
- function getNextState() {
+ public function getNextState() {
if ($this->_type & self::FINISH) {
return NULL;
}
* 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
- * @access public
*/
- function validate(&$data) {
+ public function validate(&$data) {
$data['valid'][$this->_name] = TRUE;
}
* 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
- * @access public
*/
- function invalidate(&$data) {
+ public function invalidate(&$data) {
$data['valid'][$this->_name] = NULL;
}
/**
- * Getter for name
+ * Getter for name.
*
* @return string
- * @access public
*/
- function getName() {
+ public function getName() {
return $this->_name;
}
/**
- * Setter for name
- *
- * @param string
+ * Setter for name.
*
* @return void
- * @access public
*/
- function setName($name) {
+ public function setName($name) {
$this->_name = $name;
}
/**
- * Getter for type
+ * Getter for type.
*
* @return int
- * @access public
*/
- function getType() {
+ public function getType() {
return $this->_type;
}
-}
+}