X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FBAO%2FEmail.php;h=7b459fbfe57745a141d6cbf92b7afe0b3706adbb;hb=d36b8b20ac964dc3c0a74f98f580dc7b0ad7383e;hp=a42659940fceec9d2f39d3c91d518db00e7e174f;hpb=681aa547248b9c7d92d368f4879f75f941eba90b;p=civicrm-core.git diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index a42659940f..7b459fbfe5 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -42,7 +42,8 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { * Create email address - note that the create function calls 'add' but * has more business logic * - * @param array $params input parameters + * @param array $params + * Input parameters. * * @return object */ @@ -60,9 +61,11 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { /** * Takes an associative array and adds email * - * @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_Email object on success, null otherwise + * @return object + * CRM_Core_BAO_Email object on success, null otherwise * @static */ public static function add(&$params) { @@ -88,9 +91,9 @@ UPDATE civicrm_email SET is_bulkmail = 0 WHERE contact_id = {$params['contact_id']} "; - if($hook == 'edit'){ - $sql .= " AND id <> {$params['id']}"; - } + if ($hook == 'edit') { + $sql .= " AND id <> {$params['id']}"; + } CRM_Core_DAO::executeQuery($sql); } @@ -112,7 +115,8 @@ WHERE contact_id = {$params['contact_id']} * 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 @@ -124,11 +128,13 @@ WHERE contact_id = {$params['contact_id']} /** * Get all the emails for a specified contact_id, with the primary email being first * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * - * @return array the array of email id's + * @return array + * the array of email id's * @static */ public static function allEmails($id, $updateBlankLocInfo = FALSE) { @@ -156,8 +162,8 @@ ORDER BY civicrm_email.is_primary DESC, email_id ASC "; ); $emails = $values = array(); - $dao = CRM_Core_DAO::executeQuery($query, $params); - $count = 1; + $dao = CRM_Core_DAO::executeQuery($query, $params); + $count = 1; while ($dao->fetch()) { $values = array( 'locationType' => $dao->locationType, @@ -181,10 +187,12 @@ ORDER BY civicrm_email.is_primary DESC, email_id ASC "; /** * Get all the emails for a specified location_block id, with the primary email 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 email id's + * @return array + * the array of email id's * @static */ public static function allEntityEmails(&$entityElements) { @@ -195,7 +203,6 @@ ORDER BY civicrm_email.is_primary DESC, email_id ASC "; $entityId = $entityElements['entity_id']; $entityTable = $entityElements['entity_table']; - $sql = " SELECT email, ltype.name as locationType, e.is_primary as is_primary, e.on_hold as on_hold,e.id as email_id, e.location_type_id as locationTypeId FROM civicrm_loc_block loc, civicrm_email e, civicrm_location_type ltype, {$entityTable} ev WHERE ev.id = %1 @@ -230,7 +237,8 @@ ORDER BY e.is_primary DESC, email_id ASC "; /** * Set / reset hold status for an email * - * @param object $email email object + * @param object $email + * Email object. * * @return void * @static @@ -261,8 +269,8 @@ AND reset_date IS NULL "; if (CRM_Core_DAO::singleValueQuery($sql, $params)) { //set reset date only if it is not set and if hold date is set - $email->on_hold = FALSE; - $email->hold_date = 'null'; + $email->on_hold = FALSE; + $email->hold_date = 'null'; $email->reset_date = date('YmdHis'); } } @@ -278,12 +286,13 @@ AND reset_date IS NULL * Build From Email as the combination of all the email ids of the logged in user and * the domain email id * - * @return array an array of email ids + * @return array + * an array of email ids * @static */ public static function getFromEmail() { - $session = CRM_Core_Session::singleton(); - $contactID = $session->get('userID'); + $session = CRM_Core_Session::singleton(); + $contactID = $session->get('userID'); $fromEmailValues = array(); // add all configured FROM email addresses @@ -329,4 +338,3 @@ AND reset_date IS NULL return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Email', $id); } } -