Merge pull request #5967 from colemanw/CRM-16632
[civicrm-core.git] / CRM / Core / State.php
index b5baf68f676fed0de9e8ee857785e17d6684ecb9..afedce9c7be7c6e9c8525afa1a3a9fa34e04604e 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -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
  * 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;
@@ -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.
@@ -174,7 +174,7 @@ class CRM_Core_State {
   }
 
   /**
-   * Getter for name
+   * Getter for name.
    *
    * @return string
    */
@@ -183,7 +183,7 @@ class CRM_Core_State {
   }
 
   /**
-   * Setter for name
+   * Setter for name.
    *
    * @return void
    */
@@ -192,11 +192,12 @@ class CRM_Core_State {
   }
 
   /**
-   * Getter for type
+   * Getter for type.
    *
    * @return int
    */
   public function getType() {
     return $this->_type;
   }
+
 }