CRM-19372 allow payment processors to define an array of accepted credit card types
[civicrm-core.git] / CRM / Core / StateMachine.php
index 4b386277723059e432ffa7c19e86f4f4c6075264..84eef8255b7964590aeab0555cf2e00f15a54e06 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2015                                |
+ | Copyright CiviCRM LLC (c) 2004-2016                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2016
  */
 
 /**
- * Core StateMachine. All statemachines subclass for the core one
- * for functionality specific to their needs.
+ * Core StateMachine.
  *
- * A statemachine keeps track of different states and forms for a
- * html quickform controller.
+ * All state machines subclass for the core one for functionality specific to their needs.
  *
+ * A state machine keeps track of different states and forms for a
+ * html quickform controller.
  */
 class CRM_Core_StateMachine {
 
@@ -112,8 +110,6 @@ class CRM_Core_StateMachine {
    * Setter for name.
    *
    * @param string $name
-   *
-   * @return void
    */
   public function setName($name) {
     $this->_name = $name;
@@ -133,7 +129,7 @@ class CRM_Core_StateMachine {
    * @param string $type
    *   The type of transition being requested (Next or Back).
    *
-   * @return void
+   * @return object
    */
   public function perform(&$page, $actionName, $type = 'Next') {
     // save the form values and validation status to the session
@@ -183,8 +179,6 @@ class CRM_Core_StateMachine {
    *   The previous page if any.
    * @param object $next
    *   The next page if any.
-   *
-   * @return void
    */
   public function addState($name, $type, $prev, $next) {
     $this->_states[$name] = new CRM_Core_State($name, $type, $prev, $next, $this);
@@ -318,8 +312,6 @@ class CRM_Core_StateMachine {
 
   /**
    * Reset the state machine.
-   *
-   * @return void
    */
   public function reset() {
     $this->_controller->reset();
@@ -339,8 +331,6 @@ class CRM_Core_StateMachine {
    *
    * @param string $content
    *   The content generated by this state machine.
-   *
-   * @return void
    */
   public function setContent(&$content) {
     $this->_controller->setContent($content);