CRM-15988 - Cleanup internal use of entity names

[civicrm-core.git] / CRM / Core / State.php

diff --git a/CRM/Core/State.php b/CRM/Core/State.php
index 48d67bbb9c9a5f342fc443f1a90d432fcdc2a783..323dc3df39944a90de4783ed132d74712ba17a20 100644 (file)
--- a/CRM/Core/State.php
+++ b/CRM/Core/State.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -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,32 +39,32 @@
 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
+   * The state machine that this state is part of.
+   * @var CRM_Core_StateMachine
    */
   protected $_stateMachine;
 
@@ -74,27 +74,25 @@ class CRM_Core_State {
    * 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
-   *
-   * @param $name
-   * @param $type
-   * @param $back
-   * @param $next
-   * @param $stateMachine
-   *
-   * @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
+   * 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.
+   *
+   * @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;
@@ -103,19 +101,17 @@ class CRM_Core_State {
     $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');
     }
@@ -128,12 +124,10 @@ 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
-   * @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');
     }
@@ -148,9 +142,8 @@ class CRM_Core_State {
    * to display the navigation labels or potential path
    *
    * @return string
-   * @access public
    */
-  function getNextState() {
+  public function getNextState() {
     if ($this->_type & self::FINISH) {
       return NULL;
     }
@@ -164,12 +157,9 @@ 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
-   * @access public
    */
-  function validate(&$data) {
+  public function validate(&$data) {
     $data['valid'][$this->_name] = TRUE;
   }
 
@@ -177,45 +167,37 @@ 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
-   * @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;
   }
-}
 
+}