class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a groupContact object
+ * Takes an associative array and creates a groupContact object
*
* the function extract all the params it needs to initialize the create a
* group object. the params array could contain additional unused name/value
*
* @param array $params (reference ) an assoc array of name/value pairs
*
- * @return object CRM_Contact_BAO_Group object
+ * @return CRM_Contact_BAO_Group object
* @access public
* @static
*/
* @param array $params input parameters to find object
* @param array $values output values of the object
*
- * @internal param array $ids the array that holds all the db ids
- *
* @return array (reference) the values that could be potentially assigned to smarty
* @access public
* @static
}
/**
- * Function to get list of all the groups and groups for a contact
+ * Get list of all the groups and groups for a contact
*
* @param int $contactId contact id
*
}
/**
- * Function to get the list of groups for contact based on status of group membership
+ * Get the list of groups for contact based on status of group membership
*
* @param int $contactId contact id
* @param string $status state of membership
}
/**
- * takes an associative array and creates / removes
+ * Takes an associative array and creates / removes
* contacts from the groups
*
*
}
}
+ /**
+ * @param int $contactID
+ * @param int $groupID
+ *
+ * @return bool
+ */
static function isContactInGroup($contactID, $groupID) {
if (!CRM_Utils_Rule::positiveInteger($contactID) ||
!CRM_Utils_Rule::positiveInteger($groupID)
/**
* Given an array of contact ids, add all the contacts to the group
*
- * @param $contactIDs
- * @param $groupID
+ * @param array $contactIDs the array of contact ids to be added
+ * @param int $groupID the id of the group
* @param string $method
* @param string $status
* @param null $tracking
- * @internal param array $contactIds (reference ) the array of contact ids to be added
- * @internal param int $groupId the id of the group
*
* @return array (total, added, notAdded) count of contacts added to group
* @access public