X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FState.php;h=323dc3df39944a90de4783ed132d74712ba17a20;hb=4846df9154866b0a33ee8ec7a1f48c65c77b670b;hp=8b003a089590f44679f2fedee8a64c27659a068b;hpb=d36b8b20ac964dc3c0a74f98f580dc7b0ad7383e;p=civicrm-core.git diff --git a/CRM/Core/State.php b/CRM/Core/State.php index 8b003a0895..323dc3df39 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -23,7 +23,7 @@ | 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 @@ -39,7 +39,7 @@ class CRM_Core_State { /** - * State name + * State name. * @var string */ protected $_name; @@ -51,19 +51,19 @@ class CRM_Core_State { 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; @@ -77,7 +77,7 @@ class CRM_Core_State { const START = 1, FINISH = 2, SIMPLE = 4; /** - * Constructor + * Constructor. * * @param string $name * Internal name of the state. @@ -108,8 +108,6 @@ class CRM_Core_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 */ @@ -126,8 +124,6 @@ class CRM_Core_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 */ @@ -161,8 +157,6 @@ class CRM_Core_State { * 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) { @@ -173,8 +167,6 @@ class CRM_Core_State { * 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) { @@ -182,7 +174,7 @@ class CRM_Core_State { } /** - * Getter for name + * Getter for name. * * @return string */ @@ -191,9 +183,7 @@ class CRM_Core_State { } /** - * Setter for name - * - * @param string + * Setter for name. * * @return void */ @@ -202,11 +192,12 @@ class CRM_Core_State { } /** - * Getter for type + * Getter for type. * * @return int */ public function getType() { return $this->_type; } + }