comment fixes
authoreileenmcnaugton <eileen@fuzion.co.nz>
Mon, 31 Aug 2015 13:20:46 +0000 (01:20 +1200)
committereileenmcnaugton <eileen@fuzion.co.nz>
Mon, 31 Aug 2015 13:20:46 +0000 (01:20 +1200)
CRM/Core/I18n/Schema.php
CRM/Core/Page/Basic.php
CRM/Core/Payment/GoogleIPN.php
CRM/Core/Payment/PayPalProIPN.php
CRM/Core/Payment/PayflowPro.php
CRM/Core/QuickForm/Action.php
CRM/Core/QuickForm/Action/Back.php
CRM/Core/QuickForm/Action/Cancel.php
CRM/Core/QuickForm/Action/Display.php
CRM/Core/QuickForm/Action/Done.php

index 658c35aad63d09e342e1315df606c9159aeadcd4..c77f0faf544d9b0a7410495a0f0176722a049914 100644 (file)
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Core_I18n_Schema {
 
   /**
    * Drop all views (for use by CRM_Core_DAO::dropAllTables() mostly).
-   *
-   * @return void
    */
   public static function dropAllViews() {
     $domain = new CRM_Core_DAO_Domain();
@@ -62,8 +58,6 @@ class CRM_Core_I18n_Schema {
    *
    * @param string $locale
    *   the first locale to create (migrate to).
-   *
-   * @return void
    */
   public static function makeMultilingual($locale) {
     $domain = new CRM_Core_DAO_Domain();
@@ -117,8 +111,6 @@ class CRM_Core_I18n_Schema {
    *
    * @param string $retain
    *   the locale to retain.
-   *
-   * @return void
    */
   public static function makeSinglelingual($retain) {
     $domain = new CRM_Core_DAO_Domain();
@@ -163,8 +155,6 @@ class CRM_Core_I18n_Schema {
    *   schema structure class to use to recreate indices.
    *
    * @param array $triggers
-   *
-   * @return void
    */
   public static function makeSinglelingualTable(
     $retain,
@@ -244,8 +234,6 @@ class CRM_Core_I18n_Schema {
    *   the new locale to add.
    * @param string $source
    *   the locale to copy from.
-   *
-   * @return void
    */
   public static function addLocale($locale, $source) {
     // get the current supported locales
@@ -303,8 +291,6 @@ class CRM_Core_I18n_Schema {
    *   locales to be rebuilt.
    * @param string $version
    *   version of schema structure to use.
-   *
-   * @return void
    */
   public static function rebuildMultilingualSchema($locales, $version = NULL) {
     if ($version) {
index 03f20b5728073b7f41c7bb74b7f1a8cd209bcea0..2560d5fee5ca193b43c5949b706a4cd114b69fe6 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
 
@@ -112,8 +110,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
    *
    * @param CRM_Core_Controller $controller
    *   The controller object.
-   *
-   * @return void
    */
   public function addValues($controller) {
   }
@@ -134,12 +130,10 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
 
   /**
    * Run the basic page (run essentially starts execution for that page).
-   *
-   * @return void
    */
   public function run() {
     // CRM-9034
-    // dont see args or pageArgs being used, so we should
+    // do not see args or pageArgs being used, so we should
     // consider eliminating them in a future version
     $n = func_num_args();
     $args = ($n > 0) ? func_get_arg(0) : NULL;
@@ -190,8 +184,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
 
   /**
    * Browse all entities.
-   *
-   * @return void
    */
   public function browse() {
     $n = func_num_args();
@@ -288,8 +280,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
    *   The permission assigned to this object.
    *
    * @param bool $forceAction
-   *
-   * @return void
    */
   public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
     $values['class'] = '';
@@ -370,8 +360,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
    *
    * @param bool $imageUpload
    * @param bool $pushUserContext
-   *
-   * @return void
    */
   public function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
     $controller = new CRM_Core_Controller_Simple($this->editForm(),
index dffaba07eab57302351f81ea70802ff28e845e44..b3832b5b2ccb46a25c1f632a125f3564973218c5 100644 (file)
  * limitations under the License.
  */
 
-/* This is the response handler code that will be invoked every time
-  * a notification or request is sent by the Google Server
+/**
+ * Response handler code.
+ *
+ * This will be invoked every time a notification or request is sent by the Google Server.
   *
   * To allow this code to receive responses, the url for this file
   * must be set on the seller page under Settings->Integration as the
   * To use this code for merchant-calculated feedback, this url must be
   * set also as the merchant-calculations-url when the cart is posted
   * Depending on your calculations for shipping, taxes, coupons and gift
-  * certificates update parts of the code as required
-  *
+  * certificates update parts of the code as required.
   */
 
-
 define('GOOGLE_DEBUG_PP', 0);
 
 /**
- * Class CRM_Core_Payment_GoogleIPN
+ * Class CRM_Core_Payment_GoogleIPN.
  */
 class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
 
@@ -107,9 +107,9 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
    * @param array $privateData
    *   Contains the name value pair of <merchant-private-data>.
    *
-   * @param $component
+   * @param string $component
    *
-   * @return void
+   * @return bool
    */
   public function newOrderNotify($dataRoot, $privateData, $component) {
     $ids = $input = $params = array();
@@ -149,7 +149,7 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
     if ($ids['contributionRecur']) {
       if ($objects['contributionRecur']->invoice_id == $dataRoot['serial-number']) {
         CRM_Core_Error::debug_log_message("The new order notification already handled: {$dataRoot['serial-number']}.");
-        return;
+        return FALSE;
       }
       else {
         $transaction = new CRM_Core_Transaction();
@@ -196,8 +196,8 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
     $contribution = &$objects['contribution'];
 
     if ($contribution->invoice_id != $input['invoice']) {
-      CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request");
-      return;
+      CRM_Core_Error::debug_log_message("Invoice values don't match between database and IPN request");
+      return FALSE;
     }
 
     // lets replace invoice-id with google-order-number because thats what is common and unique
@@ -208,7 +208,7 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
 
     if ($contribution->total_amount != $input['amount']) {
       CRM_Core_Error::debug_log_message("Amount values dont match between database and IPN request");
-      return;
+      return FALSE;
     }
 
     if (!$this->getInput($input, $ids, $dataRoot)) {
@@ -220,7 +220,7 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
     // check if contribution is already completed, if so we ignore this ipn
     if ($contribution->contribution_status_id == 1) {
       CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
-      return;
+      return FALSE;
     }
     else {
       /* Since trxn_id hasn't got any use here,
@@ -250,9 +250,9 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
    * @param array $privateData
    *   Contains the name value pair of <merchant-private-data>.
    *
-   * @param $component
+   * @param string $component
    *
-   * @return void
+   * @return bool
    */
   public function orderStateChange($status, $dataRoot, $privateData, $component) {
     $input = $objects = $ids = array();
@@ -267,14 +267,14 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {
 
     if (!$contribution->find(TRUE)) {
       CRM_Core_Error::debug_log_message("orderStateChange: Could not find contribution record with invoice id: $serial");
-      return;
+      return FALSE;
     }
 
     // Google sends the charged notification twice.
     // So to make sure, code is not executed again.
     if ($contribution->contribution_status_id == 1) {
       CRM_Core_Error::debug_log_message("Contribution already handled (ContributionID = {$contribution->id}).");
-      return;
+      return FALSE;
     }
 
     // make sure invoice is set to serial no for recurring payments, to avoid violating uniqueness
index fd6a7f64b6d8a54ef291e854ac1f66d515dfef7a..efde8f24dbeaab13b5594590e55e865b817c5273 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
 
@@ -163,7 +161,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
    * @param array $ids
    * @param array $objects
    * @param bool $first
-   * @return void|bool
+   * @return bool
    */
   public function recur(&$input, &$ids, &$objects, $first) {
     if (!isset($input['txnType'])) {
@@ -232,7 +230,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
           && !empty($recur->processor_id)
         ) {
           echo "already handled";
-          return;
+          return FALSE;
         }
         $recur->create_date = $now;
         $recur->contribution_status_id = 2;
@@ -254,7 +252,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
         if ($this->retrieve('profile_status', 'String') == 'Expired') {
           if (!empty($recur->end_date)) {
             echo "already handled";
-            return;
+            return FALSE;
           }
           $recur->contribution_status_id = 1;
           $recur->end_date = $now;
@@ -289,7 +287,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
     }
 
     if ($txnType != 'recurring_payment') {
-      return;
+      return TRUE;
     }
 
     if (!$first) {
@@ -391,14 +389,14 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
    * (with the input parameters) & call this & all will be done
    *
    * @todo the references to POST throughout this class need to be removed
-   * @return void|bool
+   * @return bool
    */
   public function main() {
     CRM_Core_Error::debug_var('GET', $_GET, TRUE, TRUE);
     CRM_Core_Error::debug_var('POST', $_POST, TRUE, TRUE);
     if ($this->_isPaymentExpress) {
       $this->handlePaymentExpress();
-      return NULL;
+      return FALSE;
     }
     $objects = $ids = $input = array();
     $this->_component = $input['component'] = self::getValue('m');
index af5603d443433b6a6c31f1982270bdf09db7c54c..a28a840ee9f593407b5be05f124b2a4fe01f73a7 100644 (file)
@@ -10,7 +10,7 @@
   */
 
 /**
- * Class CRM_Core_Payment_PayflowPro
+ * Class CRM_Core_Payment_PayflowPro.
  */
 class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment {
   // (not used, implicit in the API, might need to convert?)
@@ -30,11 +30,6 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment {
    *
    * @param string $mode
    *   The mode of operation: live or test.
-   *
-   * @return void
-   */
-  /**
-   * @param $mode
    * @param $paymentProcessor
    */
   public function __construct($mode, &$paymentProcessor) {
index 5c4eceada6c29ae3475a3ccb44505fd604200d1a..7a89506e80409e37a1c8f7d6e45b67d897a3177b 100644 (file)
@@ -31,8 +31,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 require_once 'HTML/QuickForm/Action.php';
 
@@ -61,8 +59,6 @@ class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action {
 
   /**
    * Returns the user to the top of the user context stack.
-   *
-   * @return void
    */
   public function popUserContext() {
     $session = CRM_Core_Session::singleton();
index 74a14fc4f6cd44ef6a44001cb6adfa802ecdb335..9efddba2ab89c67f4732acb58b1c80798eba65d6 100644 (file)
@@ -30,8 +30,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action {
 
@@ -54,8 +52,6 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action {
    *   The current form-page.
    * @param string $actionName
    *   Current action name, as one Action object can serve multiple actions.
-   *
-   * @return void
    */
   public function perform(&$page, $actionName) {
     $this->_stateMachine->perform($page, $actionName, 'Back');
index 1b3d27ffc115b1afeefe6b99d8d4cbeecabcacac..5b1729c5fa7c2dbde7a7ec0ae1a2d35b7cab26d2 100644 (file)
@@ -30,8 +30,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action {
 
@@ -54,8 +52,6 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action {
    *   CRM_Core_Form the current form-page.
    * @param string $actionName
    *   Current action name, as one Action object can serve multiple actions.
-   *
-   * @return void
    */
   public function perform(&$page, $actionName) {
     // conditional actions if cancelAction is defined
index 4b77758527bbd0f09bb140c5fefe7c175c71b07b..3d1fb007827468c64c642da410b711e88733625d 100644 (file)
@@ -30,8 +30,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
 
@@ -67,7 +65,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
    * @param string $actionName
    *   Current action name, as one Action object can serve multiple actions.
    *
-   * @return void
+   * @return object|void
    */
   public function perform(&$page, $actionName) {
     $pageName = $page->getAttribute('id');
@@ -106,9 +104,6 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
    *
    * @param CRM_Core_Form $page
    *   The CRM_Core_Form page.
-   *
-   *
-   * @return void
    */
   public function renderForm(&$page) {
     $this->_setRenderTemplates($page);
@@ -191,8 +186,6 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
    *
    * @param CRM_Core_Form $page
    *   The CRM_Core_Form page.
-   *
-   * @return void
    */
   public function _setRenderTemplates(&$page) {
     if (self::$_requiredTemplate === NULL) {
@@ -207,8 +200,6 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
 
   /**
    * Initialize the various templates.
-   *
-   * @return void
    */
   public function initializeTemplates() {
     if (self::$_requiredTemplate !== NULL) {
index 4cba4bb3952fef11cc21adc893c8b95265ee50bc..f7ce6cc43afaf2ab64e1ebd88a0943abb892cbb4 100644 (file)
@@ -30,8 +30,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action {
 
@@ -58,7 +56,7 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action {
    * @param string $actionName
    *   Current action name, as one Action object can serve multiple actions.
    *
-   * @return void
+   * @return object|void
    */
   public function perform(&$page, $actionName) {
     $page->isFormBuilt() or $page->buildForm();