<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
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;
* bring in more complexity to the framework. For now, lets keep it simple
* @var int
*/
- CONST START = 1, FINISH = 2, SIMPLE = 4;
+ const START = 1, FINISH = 2, SIMPLE = 4;
/**
- * constructor
+ * Constructor
*
- * @param $name
- * @param $type
- * @param $back
- * @param $next
- * @param $stateMachine
+ * @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
*
- * @internal param \the $string internal name of the state
- * @internal param \the $int state type
- * @internal param \the $object state that precedes this state
- * @internal param \the $object state that follows this state
- * @internal param \the $object statemachine that this states belongs to
- *
- * @return \CRM_Core_State
- @access public
+ * @return CRM_Core_State
*/
- 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}");
}
* @param object the CRM_Core_Form element under consideration
*
* @return mixed does a jump to the back state
- * @access public
*/
- function handleBackState(&$page) {
+ public function handleBackState(&$page) {
if ($this->_type & self::START) {
$page->handle('display');
}
* @param object the CRM_Core_Form element under consideration
*
* @return mixed does a jump to the nextstate
- * @access public
*/
- 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;
}
* @param object the QFC data container
*
* @return void
- * @access public
*/
- function validate(&$data) {
+ public function validate(&$data) {
$data['valid'][$this->_name] = TRUE;
}
* @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
+ * Setter for name
*
* @param string
*
* @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;
}
}
-