X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FBAO%2FEntityTag.php;h=f4a8c16928213bbfeb3523dd87c88d2b16c06202;hb=1e66775e6f88ac33d643ca2d68577ab01dd41dd5;hp=a43d0978d7bd75984eb43634a15e7962ab3f9ebe;hpb=4de9f9328a1b4a7daf9802bdb6a6d9989b554fe8;p=civicrm-core.git diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index a43d0978d7..f4a8c16928 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.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 | +--------------------------------------------------------------------+ -*/ + */ /** * This class contains functions for managing Tag(tag) for a contact @@ -45,10 +45,9 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param string $entityTable * Name of the entity table usually 'civicrm_contact'. * - * @return array( - * ) reference $tag array of category id's the contact belongs to. + * @return array + * reference $tag array of category id's the contact belongs to. * - * @static */ public static function &getTag($entityID, $entityTable = 'civicrm_contact') { $tags = array(); @@ -74,8 +73,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Core_BAO_EntityTag object - * @static + * @return CRM_Core_BAO_EntityTag */ public static function add(&$params) { $dataExists = self::dataExists($params); @@ -105,8 +103,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param array $params * An assoc array of name/value pairs. * - * @return boolean - * @static + * @return bool */ public static function dataExists($params) { return !($params['tag_id'] == 0); @@ -117,9 +114,6 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @param array $params * (reference ) an assoc array of name/value pairs. - * - * @return CRM_Core_BAO_EntityTag object - * @static */ public static function del(&$params) { $entityTag = new CRM_Core_BAO_EntityTag(); @@ -143,7 +137,6 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @return array * (total, added, notAdded) count of enities added to tag - * @static */ public static function addEntitiesToTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') { $numEntitiesAdded = 0; @@ -189,7 +182,6 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @return array * (total, removed, notRemoved) count of entities removed from tags - * @static */ public static function removeEntitiesFromTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') { $numEntitiesRemoved = 0; @@ -232,7 +224,6 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param int $entityID * * @return void - * @static */ public static function create(&$params, $entityTable, $entityID) { // get categories for the entity id @@ -397,15 +388,17 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Get options for a given field. + * * @see CRM_Core_DAO::buildOptions + * @see CRM_Core_DAO::buildOptionsContext * * @param string $fieldName * @param string $context - * : @see CRM_Core_DAO::buildOptionsContext. + * As per CRM_Core_DAO::buildOptionsContext. * @param array $props - * : whatever is known about this dao object. + * whatever is known about this dao object. * - * @return Array|bool + * @return array|bool */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { $params = array(); @@ -420,4 +413,5 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { return $options; } + }