CRM-19372 allow payment processors to define an array of accepted credit card types

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

diff --git a/CRM/Core/State.php b/CRM/Core/State.php
index 0b385e3ffb2edc17cb57a71dbb5ca97d2fa2a236..2f1d0635dd57c952baac639c8aa50df2b2f00f41 100644 (file)
--- a/CRM/Core/State.php
+++ b/CRM/Core/State.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2015                                |
+ | Copyright CiviCRM LLC (c) 2004-2016                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,7 +32,7 @@
  * things like going back / stepping forward / process etc
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
+ * @copyright CiviCRM LLC (c) 2004-2016
  */
 class CRM_Core_State {
 
@@ -104,7 +104,9 @@ class CRM_Core_State {
   }
 
   /**
-   * Given an CRM Form, jump to the previous page
+   * Given an CRM Form, jump to the previous page.
+   *
+   * @param CRM_Core_Page $page
    *
    * @return mixed
    *   does a jump to the back state
@@ -120,10 +122,12 @@ class CRM_Core_State {
   }
 
   /**
-   * Given an CRM Form, jump to the next page
+   * Given an CRM Form, jump to the next page.
+   *
+   * @param CRM_Core_Page $page
    *
    * @return mixed
-   *   does a jump to the nextstate
+   *   Does a jump to the nextstate
    */
   public function handleNextState(&$page) {
     if ($this->_type & self::FINISH) {
@@ -136,8 +140,9 @@ class CRM_Core_State {
   }
 
   /**
-   * Determine the name of the next state. This is useful when we want
-   * to display the navigation labels or potential path
+   * Determine the name of the next state.
+   *
+   * This is useful when we want to display the navigation labels or potential path.
    *
    * @return string
    */
@@ -153,6 +158,8 @@ class CRM_Core_State {
 
   /**
    * Mark this page as valid for the QFC framework.
+   *
+   * @param array $data
    */
   public function validate(&$data) {
     $data['valid'][$this->_name] = TRUE;
@@ -160,6 +167,8 @@ class CRM_Core_State {
 
   /**
    * Mark this page as invalid for the QFC framework.
+   *
+   * @param array $data
    */
   public function invalidate(&$data) {
     $data['valid'][$this->_name] = NULL;
@@ -176,6 +185,8 @@ class CRM_Core_State {
 
   /**
    * Setter for name.
+   *
+   * @param string $name
    */
   public function setName($name) {
     $this->_name = $name;