| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
class CRM_Core_BAO_IM extends CRM_Core_DAO_IM {
/**
- * Takes an associative array and adds im
+ * Takes an associative array and adds im.
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_IM object on success, null otherwise
- * @static
+ * @return object
+ * CRM_Core_BAO_IM object on success, null otherwise
*/
public static function add(&$params) {
$hook = empty($params['id']) ? 'create' : 'edit';
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
- * @param array entityBlock input parameters to find object
+ * @param array $entityBlock input parameters to find object
*
- * @return boolean
- * @static
+ * @return bool
*/
public static function &getValues($entityBlock) {
return CRM_Core_BAO_Block::getValues('im', $entityBlock);
/**
* Get all the ims for a specified contact_id, with the primary im being first
*
- * @param int $id the contact id
+ * @param int $id
+ * The contact id.
*
* @param bool $updateBlankLocInfo
*
- * @return array the array of im details
- * @static
+ * @return array
+ * the array of im details
*/
public static function allIMs($id, $updateBlankLocInfo = FALSE) {
if (!$id) {
civicrm_im.is_primary DESC, im_id ASC ";
$params = array(1 => array($id, 'Integer'));
- $ims = $values = array();
- $dao = CRM_Core_DAO::executeQuery($query, $params);
+ $ims = $values = array();
+ $dao = CRM_Core_DAO::executeQuery($query, $params);
$count = 1;
while ($dao->fetch()) {
$values = array(
/**
* Get all the ims for a specified location_block id, with the primary im being first
*
- * @param array $entityElements the array containing entity_id and
- * entity_table name
+ * @param array $entityElements
+ * The array containing entity_id and.
+ * entity_table name
*
- * @return array the array of im details
- * @static
+ * @return array
+ * the array of im details
*/
public static function allEntityIMs(&$entityElements) {
if (empty($entityElements)) {
return NULL;
}
-
-
$entityId = $entityElements['entity_id'];
$entityTable = $entityElements['entity_table'];
-
-
$sql = "SELECT cim.name as im, ltype.name as locationType, cim.is_primary as is_primary, cim.id as im_id, cim.location_type_id as locationTypeId
FROM civicrm_loc_block loc, civicrm_im cim, civicrm_location_type ltype, {$entityTable} ev
WHERE ev.id = %1
}
/**
- * Call common delete function
+ * Call common delete function.
*/
public static function del($id) {
return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('IM', $id);
}
+
}