Merge pull request #5086 from deepak-srivastava/CRM-15490

[civicrm-core.git] / CRM / Price / BAO / LineItem.php

diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php
index b1078fac7ac74bb9ccb37f8a1d053a79f41599cb..f056ed78a7e38bbab2d907fd71e78cfb52b28c50 100644 (file)
--- a/CRM/Price/BAO/LineItem.php
+++ b/CRM/Price/BAO/LineItem.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -52,7 +52,6 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
    *   (reference) an assoc array of name/value pairs.
    *
    * @return CRM_Price_DAO_LineItem
-   * @static
    */
   public static function create(&$params) {
     $id = CRM_Utils_Array::value('id', $params);
@@ -85,10 +84,9 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects.  Typically, the valid params are only
-   * price_field_id.  This is the inverse function of create.  It also
-   * stores all of the retrieved values in the default array.
+   * Retrieve DB object based on input parameters.
+   *
+   * It also stores all the retrieved values in the default array.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
@@ -96,7 +94,6 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
    *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Price_BAO_LineItem
-   * @static
    */
   public static function retrieve(&$params, &$defaults) {
     $lineItem = new CRM_Price_BAO_LineItem();
@@ -125,7 +122,7 @@ AND li.entity_id = {$entityId}
   }
 
   /**
-   * Wrapper for line item retrieval when contribution ID is known
+   * Wrapper for line item retrieval when contribution ID is known.
    * @param int $contributionID
    *
    * @return array
@@ -340,7 +337,6 @@ AND li.entity_id = {$entityId}
    * @param int $entityTable
    *
    * @return bool
-   * @static
    */
   public static function deleteLineItems($entityId, $entityTable) {
     if (!$entityId || !$entityTable) {
@@ -369,7 +365,6 @@ AND li.entity_id = {$entityId}
    * @param bool $update
    *
    * @return void
-   * @static
    */
   public static function processPriceSet($entityId, $lineItem, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
     if (!$entityId || !is_array($lineItem)
@@ -481,7 +476,6 @@ AND li.entity_id = {$entityId}
    *   Entity Table.
    *
    * @return void
-   * @static
    */
   public static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution', $isRelatedID = FALSE) {
 
@@ -535,19 +529,17 @@ AND li.entity_id = {$entityId}
   }
 
   /**
-   * Calculate tax rate in percentage
+   * Calculate tax rate in percentage.
    *
    * @param array $lineItemId
    *   An assoc array of lineItem.
    *
-   * @return number|void
+   * @return int|void
    *   tax rate
-   *
-   * @static
    */
   public static function calculateTaxRate($lineItemId) {
     if ($lineItemId['unit_price'] == 0) {
-      return;
+      return FALSE;
     }
     if ($lineItemId['html_type'] == 'Text') {
       $tax = $lineItemId['tax_amount'] / ($lineItemId['unit_price'] * $lineItemId['qty']) * 100;
@@ -557,4 +549,5 @@ AND li.entity_id = {$entityId}
     }
     return $tax;
   }
+
 }