comment fixes

[civicrm-core.git] / CRM / Core / BAO / Location.php

diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php
index cfc74cd982e0b2e33a233f7955d68f1be313db40..f527f9b6b4cc5a77893f50a44422e590a8e87b71 100644 (file)
--- a/CRM/Core/BAO/Location.php
+++ b/CRM/Core/BAO/Location.php
@@ -1,7 +1,7 @@
 <?php
 /*
   +--------------------------------------------------------------------+
-  | CiviCRM version 4.6                                                |
+  | CiviCRM version 4.7                                                |
   +--------------------------------------------------------------------+
   | Copyright CiviCRM LLC (c) 2004-2015                                |
   +--------------------------------------------------------------------+
@@ -29,12 +29,10 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class handle creation of location block elements
+ * This class handle creation of location block elements.
  */
 class CRM_Core_BAO_Location extends CRM_Core_DAO {
 
@@ -95,27 +93,12 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO {
   }
 
   /**
-   * Get the ID of the database billing location.
+   * Creates the entry in the civicrm_loc_block.
    *
-   * @return int
-   *   Billing location type id.
+   * @param string $location
+   * @param array $entityElements
    *
-   * @throws \CRM_Core_Exception
-   */
-  public static function getBillingLocationId() {
-    static $billingTypeID = NULL;
-    if ($billingTypeID) {
-      return $billingTypeID;
-    }
-    $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
-    $billingTypeID = array_search('Billing', $locationTypes);
-    if (!$billingTypeID) {
-      throw new CRM_Core_Exception(ts('Please set a location type of %1', array(1 => 'Billing')));
-    }
-    return $billingTypeID;
-  }
-  /**
-   * Creates the entry in the civicrm_loc_block.
+   * @return int
    */
   public static function createLocBlock(&$location, &$entityElements) {
     $locId = self::findExisting($entityElements);
@@ -154,6 +137,10 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO {
 
   /**
    * Takes an entity array and finds the existing location block.
+   *
+   * @param array $entityElements
+   *
+   * @return int
    */
   public static function findExisting($entityElements) {
     $eid = $entityElements['entity_id'];
@@ -177,8 +164,8 @@ WHERE e.id = %1";
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return object
-   *   CRM_Core_BAO_locBlock object on success, null otherwise
+   * @return CRM_Core_BAO_locBlock
+   *   Object on success, null otherwise
    */
   public static function addLocBlock(&$params) {
     $locBlock = new CRM_Core_DAO_LocBlock();
@@ -193,8 +180,6 @@ WHERE e.id = %1";
    *
    * @param int $locBlockId
    *   Id of the Location Block.
-   *
-   * @return void
    */
   public static function deleteLocBlock($locBlockId) {
     if (!$locBlockId) {
@@ -252,7 +237,9 @@ WHERE e.id = %1";
   }
 
   /**
-   * @param $entityBlock
+   * Get values.
+   *
+   * @param array $entityBlock
    * @param bool $microformat
    *
    * @return array
@@ -289,8 +276,6 @@ WHERE e.id = %1";
    *   Contact id.
    * @param int $locationTypeId
    *   Id of the location to delete.
-   *
-   * @return void
    */
   public static function deleteLocationBlocks($contactId, $locationTypeId) {
     // ensure that contactId has a value
@@ -367,12 +352,10 @@ WHERE e.id = %1";
   }
 
   /**
-   * If contact has data for any location block, make sure
-   * contact should have only one primary block, CRM-5051
+   * Make sure contact should have only one primary block, CRM-5051.
    *
    * @param int $contactId
    *   Contact id.
-   *
    */
   public static function checkPrimaryBlocks($contactId) {
     if (!$contactId) {
@@ -414,6 +397,8 @@ WHERE e.id = %1";
   }
 
   /**
+   * Get chain select values (whatever that means!).
+   *
    * @param mixed $values
    * @param string $valueType
    * @param bool $flatten