<?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. |
| |
* things like going back / stepping forward / process etc
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
class CRM_Core_State {
/**
- * state name
+ * State name
* @var string
*/
protected $_name;
/**
- * this is a combination "OR" of the STATE_* constants defined below
+ * This is a combination "OR" of the STATE_* constants defined below
* @var int
*/
protected $_type;
/**
- * the state that precedes this state
- * @var object
+ * The state that precedes this state
+ * @var CRM_Core_State
*/
protected $_back;
/**
- * the state that succeeds this state
- * @var object
+ * The state that succeeds this state
+ * @var CRM_Core_State
*/
protected $_next;
/**
* The state machine that this state is part of
- * @var object
+ * @var CRM_Core_StateMachine
*/
protected $_stateMachine;
CONST START = 1, FINISH = 2, SIMPLE = 4;
/**
- * constructor
+ * Constructor
*
- * @param string the internal name of the state
- * @param int the state type
- * @param object the state that precedes this state
- * @param object the state that follows this state
- * @param object the 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 object
+ * @return CRM_Core_State
* @access public
*/
function __construct($name, $type, $back, $next, &$stateMachine) {
}
/**
- * getter for name
+ * Getter for name
*
* @return string
* @access public
}
/**
- * setter for name
+ * Setter for name
*
* @param string
*
}
/**
- * getter for type
+ * Getter for type
*
* @return int
* @access public