CRM-15626 fixes - Relationship Create Widget Not always showing the correct available...

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

diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php
index 5c037548e99c2b95c7f5c924756a3e68923f5e3a..b97c978901b9f9d1be13e8f71350c76e4f602d87 100644 (file)
--- a/CRM/Core/StateMachine.php
+++ b/CRM/Core/StateMachine.php
@@ -44,19 +44,19 @@
 class CRM_Core_StateMachine {
 
   /**
-   * the controller of this state machine
+   * The controller of this state machine
    * @var object
    */
   protected $_controller;
 
   /**
-   * the list of states that belong to this state machine
+   * The list of states that belong to this state machine
    * @var array
    */
   protected $_states;
 
   /**
-   * the list of pages that belong to this state machine. Note
+   * The list of pages that belong to this state machine. Note
    * that a state and a form have a 1 <-> 1 relationship. so u
    * can always derive one from the other
    * @var array
@@ -71,7 +71,7 @@ class CRM_Core_StateMachine {
   protected $_pageNames;
 
   /**
-   * the mode that the state machine is operating in
+   * The mode that the state machine is operating in
    * @var int
    */
   protected $_action = NULL;
@@ -83,11 +83,11 @@ class CRM_Core_StateMachine {
   protected $_name = NULL;
 
   /**
-   * class constructor
+   * Class constructor
    *
    * @param object $controller the controller for this state machine
    *
-   * @param const $action
+   * @param \const|int $action
    *
    * @return \CRM_Core_StateMachine
   @access public
@@ -100,7 +100,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * getter for name
+   * Getter for name
    *
    * @return string
    * @access public
@@ -110,7 +110,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * setter for name
+   * Setter for name
    *
    * @param string
    *
@@ -122,11 +122,11 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * do a state transition jump. Currently only supported types are
+   * Do a state transition jump. Currently only supported types are
    * Next and Back. The other actions (Cancel, Done, Submit etc) do
    * not need the state machine to figure out where to go
    *
-   * @param  object    $page       CRM_Core_Form the current form-page
+   * @param  CRM_Core_Form    $page     the current form-page
    * @param  string    $actionName Current action name, as one Action object can serve multiple actions
    * @param  string    $type       The type of transition being requested (Next or Back)
    *
@@ -171,7 +171,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * helper function to add a State to the state machine
+   * Helper function to add a State to the state machine
    *
    * @param string $name  the internal name
    * @param int    $type  the type of state (START|FINISH|SIMPLE)
@@ -203,7 +203,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * return the list of state objects
+   * Return the list of state objects
    *
    * @return array array of states in the state machine
    * @access public
@@ -213,7 +213,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * return the state object corresponding to the name
+   * Return the state object corresponding to the name
    *
    * @param string $name name of page
    *
@@ -240,7 +240,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * return the list of form objects
+   * Return the list of form objects
    *
    * @return array array of pages in the state machine
    * @access public
@@ -250,7 +250,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * addSequentialStates: meta level function to create a simple
+   * AddSequentialStates: meta level function to create a simple
    * wizard for a state machine that is completely sequential.
    *
    * @access public
@@ -316,7 +316,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * reset the state machine
+   * Reset the state machine
    *
    * @return void
    * @access public
@@ -326,7 +326,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * getter for action
+   * Getter for action
    *
    * @return int
    * @access public
@@ -336,7 +336,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * setter for content
+   * Setter for content
    *
    * @param string $content the content generated by this state machine
    *
@@ -348,7 +348,7 @@ class CRM_Core_StateMachine {
   }
 
   /**
-   * getter for content
+   * Getter for content
    *
    * @return string
    * @access public
@@ -357,18 +357,30 @@ class CRM_Core_StateMachine {
     return $this->_controller->getContent();
   }
 
+  /**
+   * @return mixed
+   */
   function getDestination() {
     return $this->_controller->getDestination();
   }
 
+  /**
+   * @return mixed
+   */
   function getSkipRedirection() {
     return $this->_controller->getSkipRedirection();
   }
 
+  /**
+   * @return mixed
+   */
   function fini() {
     return $this->_controller->fini();
   }
 
+  /**
+   * @return mixed
+   */
   function cancelAction() {
     return $this->_controller->cancelAction();
   }