Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2015-03-03-23-44-14
[civicrm-core.git] / CRM / Core / BAO / Tag.php
index 7dabeda2d20e7dc86b157352d9a14502a741697a..5370623883002d9a715c6f16d014583ce3309d9e 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
 class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
 
   /**
-   * Class constructor
+   * Class constructor.
    */
   public function __construct() {
     parent::__construct();
   }
 
   /**
-   * Fetch object based on array of properties
+   * Fetch object based on array of properties.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
@@ -126,12 +126,11 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
    *
    * @return array
    */
-  public static function getTagsUsedFor($usedFor = array(
-      'civicrm_contact'
-    ),
-                                        $buildSelect = TRUE,
-                                        $all = FALSE,
-                                        $parentId = NULL
+  public static function getTagsUsedFor(
+    $usedFor = array('civicrm_contact'),
+    $buildSelect = TRUE,
+    $all = FALSE,
+    $parentId = NULL
   ) {
     $tags = array();
 
@@ -182,7 +181,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
   }
 
   /**
-   * Function to retrieve tags
+   * Function to retrieve tags.
    *
    * @param string $usedFor
    *   Which type of tag entity.
@@ -198,7 +197,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
    *
    * @return array
    */
-  static function getTags(
+  public static function getTags(
     $usedFor = 'civicrm_contact',
     &$tags = array(),
     $parentId = NULL,
@@ -315,12 +314,12 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
   }
 
   /**
-   * Delete the tag
+   * Delete the tag.
    *
    * @param int $id
    *   Tag id.
    *
-   * @return boolean
+   * @return bool
    */
   public static function del($id) {
     // since this is a destructive operation, lets make sure
@@ -346,7 +345,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
   }
 
   /**
-   * Takes an associative array and creates a contact object
+   * Takes an associative array and creates a contact object.
    *
    * The function extract all the params it needs to initialize the create a
    * contact object. the params array could contain additional unused name/value
@@ -404,12 +403,12 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
   }
 
   /**
-   * Check if there is data to create the object
+   * Check if there is data to create the object.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return boolean
+   * @return bool
    */
   public static function dataExists(&$params) {
     // Disallow empty values except for the number zero.
@@ -422,7 +421,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
   }
 
   /**
-   * Get the tag sets for a entity object
+   * Get the tag sets for a entity object.
    *
    * @param string $entityTable
    *   Entity_table.
@@ -437,8 +436,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
     $dao = CRM_Core_DAO::executeQuery($query, array(
         1 => array(
           '%' . $entityTable . '%',
-          'String'
-        )
+          'String',
+        ),
       ), TRUE, NULL, FALSE, FALSE);
     while ($dao->fetch()) {
       $tagSets[$dao->id] = $dao->name;
@@ -476,4 +475,5 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
 
     return $tags;
   }
+
 }