From 90c8230ea5763fc14fadddbc672af05942947ca6 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:09 -0800 Subject: [PATCH] INFRA-132 - CRM/Mailing - Convert single-line @param to multi-line --- CRM/Mailing/BAO/BouncePattern.php | 3 +- CRM/Mailing/BAO/Component.php | 18 ++- CRM/Mailing/BAO/Mailing.php | 126 ++++++++++++++------- CRM/Mailing/BAO/MailingAB.php | 12 +- CRM/Mailing/BAO/MailingJob.php | 9 +- CRM/Mailing/BAO/Recipients.php | 3 +- CRM/Mailing/BAO/Spool.php | 6 +- CRM/Mailing/BAO/TrackableURL.php | 9 +- CRM/Mailing/Event/BAO/Bounce.php | 27 +++-- CRM/Mailing/Event/BAO/Confirm.php | 9 +- CRM/Mailing/Event/BAO/Delivered.php | 36 ++++-- CRM/Mailing/Event/BAO/Forward.php | 27 +++-- CRM/Mailing/Event/BAO/Opened.php | 36 ++++-- CRM/Mailing/Event/BAO/Queue.php | 38 ++++--- CRM/Mailing/Event/BAO/Reply.php | 63 +++++++---- CRM/Mailing/Event/BAO/Resubscribe.php | 21 ++-- CRM/Mailing/Event/BAO/Subscribe.php | 39 ++++--- CRM/Mailing/Event/BAO/TrackableURLOpen.php | 48 +++++--- CRM/Mailing/Event/BAO/Unsubscribe.php | 60 ++++++---- CRM/Mailing/Form/Component.php | 3 +- CRM/Mailing/Form/Group.php | 3 +- CRM/Mailing/Form/Schedule.php | 3 +- CRM/Mailing/Form/Task.php | 3 +- CRM/Mailing/Form/Test.php | 6 +- CRM/Mailing/Form/Upload.php | 3 +- CRM/Mailing/MailStore.php | 9 +- CRM/Mailing/MailStore/Imap.php | 21 ++-- CRM/Mailing/MailStore/Localdir.php | 12 +- CRM/Mailing/MailStore/Maildir.php | 12 +- CRM/Mailing/MailStore/Mbox.php | 9 +- CRM/Mailing/MailStore/Pop3.php | 18 ++- CRM/Mailing/PseudoConstant.php | 9 +- CRM/Mailing/Selector/Browse.php | 24 ++-- CRM/Mailing/Selector/Event.php | 39 ++++--- CRM/Mailing/Selector/Search.php | 36 ++++-- 35 files changed, 533 insertions(+), 267 deletions(-) diff --git a/CRM/Mailing/BAO/BouncePattern.php b/CRM/Mailing/BAO/BouncePattern.php index 7ccad8395f..45fb02a1c1 100644 --- a/CRM/Mailing/BAO/BouncePattern.php +++ b/CRM/Mailing/BAO/BouncePattern.php @@ -74,7 +74,8 @@ class CRM_Mailing_BAO_BouncePattern extends CRM_Mailing_DAO_BouncePattern { /** * Try to match the string to a bounce type. * - * @param string $message The message to be matched + * @param string $message + * The message to be matched. * * @return array Tuple (bounce_type, bounce_reason) * @static diff --git a/CRM/Mailing/BAO/Component.php b/CRM/Mailing/BAO/Component.php index 7aaa908e31..0e41abf072 100644 --- a/CRM/Mailing/BAO/Component.php +++ b/CRM/Mailing/BAO/Component.php @@ -44,8 +44,10 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Core_BAO_LocaationType object * @static @@ -63,8 +65,10 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static @@ -76,8 +80,10 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { /** * Create and Update mailing component * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids (deprecated) the array that holds all the db ids + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $ids + * (deprecated) the array that holds all the db ids. * * @return CRM_Mailing_BAO_Component object * diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 4b95e16cba..e453161ba1 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -112,7 +112,8 @@ class CRM_Mailing_BAO_Mailing extends CRM_Mailing_DAO_Mailing { // note that $job_id is used only as a variable in the temp table construction // and does not play a role in the queries generated /** - * @param int $job_id (misnomer) a nonce value used to name temporary tables + * @param int $job_id + * (misnomer) a nonce value used to name temporary tables. * @param int $mailing_id * @param null $offset * @param null $limit @@ -887,7 +888,8 @@ ORDER BY i.contact_id, i.{$tempColumn} * structures to represent the order in which tokens were found from left to right, top to bottom. * * - * @param str $prop name of the property that holds the text that we want to scan for tokens (html, text) + * @param str $prop + * Name of the property that holds the text that we want to scan for tokens (html, text). * * @return void */ @@ -909,7 +911,8 @@ ORDER BY i.contact_id, i.{$tempColumn} /** * Generate an event queue for a test job * - * @param array $testParams contains form values + * @param array $testParams + * Contains form values. * * @return void */ @@ -985,12 +988,17 @@ ORDER BY civicrm_email.is_bulkmail DESC * is placed on the values received, so they do not need to follow the verp * convention. * - * @param array $headers Array of message headers to update, in-out - * @param string $prefix Prefix for the message ID, use same prefixes as verp + * @param array $headers + * Array of message headers to update, in-out. + * @param string $prefix + * Prefix for the message ID, use same prefixes as verp. * wherever possible - * @param string $job_id Job ID component of the generated message ID - * @param string $event_queue_id Event Queue ID component of the generated message ID - * @param string $hash Hash component of the generated message ID. + * @param string $job_id + * Job ID component of the generated message ID. + * @param string $event_queue_id + * Event Queue ID component of the generated message ID. + * @param string $hash + * Hash component of the generated message ID. * * @return void */ @@ -1015,10 +1023,14 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * Static wrapper for getting verp and urls * - * @param int $job_id ID of the Job associated with this message - * @param int $event_queue_id ID of the EventQueue - * @param string $hash Hash of the EventQueue - * @param string $email Destination address + * @param int $job_id + * ID of the Job associated with this message. + * @param int $event_queue_id + * ID of the EventQueue. + * @param string $hash + * Hash of the EventQueue. + * @param string $email + * Destination address. * * @return array (reference) array array ref that hold array refs to the verp info and urls */ @@ -1037,10 +1049,14 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * Get verp, urls and headers * - * @param int $job_id ID of the Job associated with this message - * @param int $event_queue_id ID of the EventQueue - * @param string $hash Hash of the EventQueue - * @param string $email Destination address + * @param int $job_id + * ID of the Job associated with this message. + * @param int $event_queue_id + * ID of the EventQueue. + * @param string $hash + * Hash of the EventQueue. + * @param string $email + * Destination address. * * @param bool $isForward * @@ -1129,17 +1145,26 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * Compose a message * - * @param int $job_id ID of the Job associated with this message - * @param int $event_queue_id ID of the EventQueue - * @param string $hash Hash of the EventQueue - * @param string $contactId ID of the Contact - * @param string $email Destination address - * @param string $recipient To: of the recipient - * @param boolean $test Is this mailing a test? + * @param int $job_id + * ID of the Job associated with this message. + * @param int $event_queue_id + * ID of the EventQueue. + * @param string $hash + * Hash of the EventQueue. + * @param string $contactId + * ID of the Contact. + * @param string $email + * Destination address. + * @param string $recipient + * To: of the recipient. + * @param bool $test + * Is this mailing a test?. * @param $contactDetails * @param $attachments - * @param boolean $isForward Is this mailing compose for forward? - * @param string $fromEmail email address of who is forwardinf it. + * @param bool $isForward + * Is this mailing compose for forward?. + * @param string $fromEmail + * Email address of who is forwardinf it. * * @param null $replyToEmail * @@ -1500,8 +1525,10 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * Add the mailings * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * @@ -1545,7 +1572,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * Construct a new mailing object, along with job and mailing_group * objects, from the form values of the create mailing wizard. * - * @params array $params Form values + * @params array $params + * Form values. * * @param array $params * @param array $ids @@ -1693,8 +1721,10 @@ ORDER BY civicrm_email.is_bulkmail DESC * Replace the list of recipients on a given mailing * * @param int $mailingId - * @param string $type 'include' or 'exclude' - * @param string $entity 'groups' or 'mailings' + * @param string $type + * 'include' or 'exclude'. + * @param string $entity + * 'groups' or 'mailings'. * @param array $entityIds * @throws CiviCRM_API3_Exception */ @@ -1726,8 +1756,10 @@ ORDER BY civicrm_email.is_bulkmail DESC * Generate a report. Fetch event count information, mailing data, and job * status. * - * @param int $id The mailing id to report - * @param boolean $skipDetails whether return all detailed report + * @param int $id + * The mailing id to report. + * @param bool $skipDetails + * Whether return all detailed report. * * @param bool $isSMS * @@ -2309,9 +2341,12 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id /** * Get the rows for a browse operation * - * @param int $offset The row number to start from - * @param int $rowCount The nmber of rows to return - * @param string $sort The sql string that describes the sort order + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The nmber of rows to return. + * @param string $sort + * The sql string that describes the sort order. * * @param null $additionalClause * @param array $additionalParams @@ -2414,7 +2449,8 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id /** * Delete Mails and all its associated records * - * @param int $id id of the mail to delete + * @param int $id + * Id of the mail to delete. * * @return void * @static @@ -2444,7 +2480,8 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id * Delete Jobss and all its associated records * related to test Mailings * - * @param int $id id of the Job to delete + * @param int $id + * Id of the Job to delete. * * @return void * @static @@ -2669,9 +2706,11 @@ SELECT $mailing.id as mailing_id /** * Get the content/components of mailing based on mailing Id * - * @param $report array of mailing report + * @param $report + * Array of mailing report. * - * @param $form reference of this + * @param $form + * Reference of this. * * @param bool $isSMS * @@ -2874,7 +2913,8 @@ AND m.id = %1 /** * This function is a wrapper for ajax activity selector * - * @param array $params associated array for params record id. + * @param array $params + * Associated array for params record id. * * @return array $contactActivities associated array of contact activities */ @@ -2959,7 +2999,8 @@ AND m.id = %1 /** * Retrieve contact mailing * - * @param array $params associated array + * @param array $params + * Associated array. * * @return array of mailings for a contact * @@ -2978,7 +3019,8 @@ AND m.id = %1 /** * Retrieve contact mailing count * - * @param array $params associated array + * @param array $params + * Associated array. * * @return int count of mailings for a contact * diff --git a/CRM/Mailing/BAO/MailingAB.php b/CRM/Mailing/BAO/MailingAB.php index 4288a35d7e..a297aad6d1 100644 --- a/CRM/Mailing/BAO/MailingAB.php +++ b/CRM/Mailing/BAO/MailingAB.php @@ -48,7 +48,8 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { /** * Construct a new mailingab object * - * @params array $params Form values + * @params array $params + * Form values. * * @param $params * @param array $ids @@ -72,8 +73,10 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { /** * function to add the mailings * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * @@ -113,7 +116,8 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { /** * Delete MailingAB and all its associated records * - * @param int $id id of the mail to delete + * @param int $id + * Id of the mail to delete. * * @return void * @static diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index 474bc962ce..4f98ac1e95 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -479,7 +479,8 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) /** * Send the mailing * - * @param object $mailer A Mail object to send the messages + * @param object $mailer + * A Mail object to send the messages. * * @param array $testParams * @@ -818,7 +819,8 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) /** * Cancel a mailing * - * @param int $mailingId the id of the mailing to be canceled + * @param int $mailingId + * The id of the mailing to be canceled. * @static */ public static function cancel($mailingId) { @@ -864,7 +866,8 @@ AND status IN ( 'Scheduled', 'Running', 'Paused' ) /** * Return a translated status enum string * - * @param string $status The status enum + * @param string $status + * The status enum. * * @return string The translated version * @static diff --git a/CRM/Mailing/BAO/Recipients.php b/CRM/Mailing/BAO/Recipients.php index a15006ade1..9978c20166 100644 --- a/CRM/Mailing/BAO/Recipients.php +++ b/CRM/Mailing/BAO/Recipients.php @@ -127,7 +127,8 @@ SET mr.mailing_id = $newMailingID * Redistribute recipients from $sourceMailingId to a series of other mailings. * * @param int $sourceMailingId - * @param array $to (int $targetMailingId => int $count) + * @param array $to + * (int $targetMailingId => int $count). */ public static function reassign($sourceMailingId, $to) { foreach ($to as $targetMailingId => $count) { diff --git a/CRM/Mailing/BAO/Spool.php b/CRM/Mailing/BAO/Spool.php index 4dae454a2d..18907022d0 100644 --- a/CRM/Mailing/BAO/Spool.php +++ b/CRM/Mailing/BAO/Spool.php @@ -45,9 +45,11 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool { * Store Mails into Spool table. * * @param $recipient - * @param array $headers The string of headers to send with the mail. + * @param array $headers + * The string of headers to send with the mail. * - * @param string $body The full text of the message body, including any + * @param string $body + * The full text of the message body, including any. * Mime parts, etc. * * @param int $job_id diff --git a/CRM/Mailing/BAO/TrackableURL.php b/CRM/Mailing/BAO/TrackableURL.php index 0bff841262..0d6458d1de 100644 --- a/CRM/Mailing/BAO/TrackableURL.php +++ b/CRM/Mailing/BAO/TrackableURL.php @@ -45,9 +45,12 @@ class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL { * Given a url, mailing id and queue event id, find or construct a * trackable url and redirect url. * - * @param string $url The target url to track - * @param int $mailing_id The id of the mailing - * @param int $queue_id The queue event id (contact clicking through) + * @param string $url + * The target url to track. + * @param int $mailing_id + * The id of the mailing. + * @param int $queue_id + * The queue event id (contact clicking through). * * @return string $redirect The redirect/tracking url * @static diff --git a/CRM/Mailing/Event/BAO/Bounce.php b/CRM/Mailing/Event/BAO/Bounce.php index 9121015f3a..1cc3dc27d1 100755 --- a/CRM/Mailing/Event/BAO/Bounce.php +++ b/CRM/Mailing/Event/BAO/Bounce.php @@ -121,9 +121,12 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. * * @return int Number of rows in result set * @static @@ -172,12 +175,18 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @return array Result set * @static diff --git a/CRM/Mailing/Event/BAO/Confirm.php b/CRM/Mailing/Event/BAO/Confirm.php index 1fb1174997..608bb6c7f3 100644 --- a/CRM/Mailing/Event/BAO/Confirm.php +++ b/CRM/Mailing/Event/BAO/Confirm.php @@ -50,9 +50,12 @@ class CRM_Mailing_Event_BAO_Confirm extends CRM_Mailing_Event_DAO_Confirm { /** * Confirm a pending subscription * - * @param int $contact_id The id of the contact - * @param int $subscribe_id The id of the subscription event - * @param string $hash The hash + * @param int $contact_id + * The id of the contact. + * @param int $subscribe_id + * The id of the subscription event. + * @param string $hash + * The hash. * * @return boolean True on success * @static diff --git a/CRM/Mailing/Event/BAO/Delivered.php b/CRM/Mailing/Event/BAO/Delivered.php index 662cf57bc1..99a4ae88d9 100755 --- a/CRM/Mailing/Event/BAO/Delivered.php +++ b/CRM/Mailing/Event/BAO/Delivered.php @@ -44,7 +44,8 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { /** * Create a new delivery event * - * @param array $params Associative array of delivery event values + * @param array $params + * Associative array of delivery event values. * * @return void * @static @@ -83,9 +84,12 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. * * @return int Number of rows in result set * @static @@ -139,12 +143,18 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @return array Result set * @static @@ -264,8 +274,10 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { * This function rectifies that by considering all non-test mailing jobs which have completed between $minDays and $maxDays * and setting the resetDate to the date that an email was delivered * - * @param integer $minDays consider mailings that were completed at least $minDays ago - * @param integer $maxDays consider mailings that were completed not more than $maxDays ago + * @param int $minDays + * Consider mailings that were completed at least $minDays ago. + * @param int $maxDays + * Consider mailings that were completed not more than $maxDays ago. * * @return void * @static diff --git a/CRM/Mailing/Event/BAO/Forward.php b/CRM/Mailing/Event/BAO/Forward.php index 887bc0cc9c..81ffbdcb95 100644 --- a/CRM/Mailing/Event/BAO/Forward.php +++ b/CRM/Mailing/Event/BAO/Forward.php @@ -216,9 +216,12 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. * * @return int Number of rows in result set * @static @@ -266,12 +269,18 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @return array Result set * @static diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index 12a00a8592..6a8338253c 100755 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -44,7 +44,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** * Register an open event * - * @param int $queue_id The Queue Event ID of the recipient + * @param int $queue_id + * The Queue Event ID of the recipient. * * @return void * @static @@ -70,9 +71,12 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. * * @return int Number of rows in result set * @static @@ -164,8 +168,10 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** * Get opened count for each mailing for a given set of mailing IDs and a specific contact * - * @param int $mailingIDs IDs of the mailing (comma separated) - * @param int $contactID ID of the contact + * @param int $mailingIDs + * IDs of the mailing (comma separated). + * @param int $contactID + * ID of the contact. * * @return array Count per mailing ID * @static @@ -204,12 +210,18 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @param int $contact_id * diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index 2e500ac838..0cf3d467d4 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -44,7 +44,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** * Queue a new recipient * - * @param array $params values of the new EventQueue + * @param array $params + * Values of the new EventQueue. * * @return CRM_Mailing_Event_BAO_Queue The new EventQueue * @static @@ -62,7 +63,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** * Create a security hash from the job, email and contact ids * - * @param array The ids to be hashed + * @param array The ids to be hashed * * @return int The hash * @static @@ -80,9 +81,12 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** * Verify that a queue event exists with the specified id/job id/hash * - * @param int $job_id The job ID of the event to find - * @param int $queue_id The Queue Event ID to find - * @param string $hash The hash to validate against + * @param int $job_id + * The job ID of the event to find. + * @param int $queue_id + * The Queue Event ID to find. + * @param string $hash + * The hash to validate against. * * @return object|null The queue event if verified, or null * @static @@ -104,7 +108,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** * Given a queue event ID, find the corresponding email address. * - * @param int $queue_id The queue event ID + * @param int $queue_id + * The queue event ID. * * @return string The email address * @static @@ -130,8 +135,10 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** * Count up events given a mailing id and optional job id * - * @param int $mailing_id ID of the mailing to count - * @param int $job_id Optional ID of a job to limit results + * @param int $mailing_id + * ID of the mailing to count. + * @param int $job_id + * Optional ID of a job to limit results. * * @return int Number of matching events * @static @@ -163,11 +170,16 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @return array Result set * @static diff --git a/CRM/Mailing/Event/BAO/Reply.php b/CRM/Mailing/Event/BAO/Reply.php index 00ffcf2950..646f6762f4 100644 --- a/CRM/Mailing/Event/BAO/Reply.php +++ b/CRM/Mailing/Event/BAO/Reply.php @@ -53,9 +53,12 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** * Register a reply event. * - * @param int $job_id The job ID of the reply - * @param int $queue_id The queue event id - * @param string $hash The hash + * @param int $job_id + * The job ID of the reply. + * @param int $queue_id + * The queue event id. + * @param string $hash + * The hash. * * @param null $replyto * @@ -102,12 +105,18 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** * Forward a mailing reply * - * @param int $queue_id Queue event ID of the sender - * @param string $mailing The mailing object - * @param string $bodyTxt text part of the body (ignored if $fullEmail provided) - * @param string $replyto Reply-to of the incoming message - * @param string $bodyHTML HTML part of the body (ignored if $fullEmail provided) - * @param string $fullEmail whole email to forward in one string + * @param int $queue_id + * Queue event ID of the sender. + * @param string $mailing + * The mailing object. + * @param string $bodyTxt + * Text part of the body (ignored if $fullEmail provided). + * @param string $replyto + * Reply-to of the incoming message. + * @param string $bodyHTML + * HTML part of the body (ignored if $fullEmail provided). + * @param string $fullEmail + * Whole email to forward in one string. * * @return void * @static @@ -205,9 +214,12 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** * Send an automated response * - * @param object $mailing The mailing object - * @param int $queue_id The queue ID - * @param string $replyto Optional reply-to from the reply + * @param object $mailing + * The mailing object. + * @param int $queue_id + * The queue ID. + * @param string $replyto + * Optional reply-to from the reply. * * @return void * @static @@ -294,9 +306,12 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. * * @return int Number of rows in result set * @static @@ -344,12 +359,18 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @return array Result set * @static diff --git a/CRM/Mailing/Event/BAO/Resubscribe.php b/CRM/Mailing/Event/BAO/Resubscribe.php index 048b3d810d..06d6ca1f03 100644 --- a/CRM/Mailing/Event/BAO/Resubscribe.php +++ b/CRM/Mailing/Event/BAO/Resubscribe.php @@ -43,9 +43,12 @@ class CRM_Mailing_Event_BAO_Resubscribe { /** * Resubscribe a contact to the groups, he/she was unsubscribed from. * - * @param int $job_id The job ID - * @param int $queue_id The Queue Event ID of the recipient - * @param string $hash The hash + * @param int $job_id + * The job ID. + * @param int $queue_id + * The Queue Event ID of the recipient. + * @param string $hash + * The hash. * * @return array|null $groups Array of all groups to which the contact was added, or null if the queue event could not be found. * @static @@ -187,10 +190,14 @@ class CRM_Mailing_Event_BAO_Resubscribe { * Send a reponse email informing the contact of the groups to which he/she * has been resubscribed. * - * @param string $queue_id The queue event ID - * @param array $groups List of group IDs - * @param bool $is_domain Is this domain-level? - * @param int $job The job ID + * @param string $queue_id + * The queue event ID. + * @param array $groups + * List of group IDs. + * @param bool $is_domain + * Is this domain-level?. + * @param int $job + * The job ID. * * @return void * @static diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index d90ecd55ad..3454fad672 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -52,9 +52,12 @@ class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe { * Register a subscription event. Create a new contact if one does not * already exist. * - * @param int $group_id The group id to subscribe to - * @param string $email The email address of the (new) contact - * @param int $contactId Currently used during event registration/contribution. + * @param int $group_id + * The group id to subscribe to. + * @param string $email + * The email address of the (new) contact. + * @param int $contactId + * Currently used during event registration/contribution. * Specifically to avoid linking group to wrong duplicate contact * during event registration. * @param string $context @@ -175,9 +178,12 @@ SELECT civicrm_email.id as email_id /** * Verify the hash of a subscription event * - * @param int $contact_id ID of the contact - * @param int $subscribe_id ID of the subscription event - * @param string $hash Hash to verify + * @param int $contact_id + * ID of the contact. + * @param int $subscribe_id + * ID of the subscription event. + * @param string $hash + * Hash to verify. * * @return object|null The subscribe event object, or null on failure * @static @@ -197,7 +203,8 @@ SELECT civicrm_email.id as email_id /** * Ask a contact for subscription confirmation (opt-in) * - * @param string $email The email address + * @param string $email + * The email address. * * @return void */ @@ -296,7 +303,8 @@ SELECT civicrm_email.id as email_id /** * Get the domain object given a subscribe event * - * @param int $subscribe_id ID of the subscribe event + * @param int $subscribe_id + * ID of the subscribe event. * * @return object $domain The domain owning the event * @static @@ -308,8 +316,10 @@ SELECT civicrm_email.id as email_id /** * Get the group details to which given email belongs * - * @param string $email email of the contact - * @param int $contactID contactID if we want an exact match + * @param string $email + * Email of the contact. + * @param int $contactID + * ContactID if we want an exact match. * * @return array $groups array of group ids */ @@ -356,9 +366,12 @@ SELECT civicrm_email.id as email_id /** * Send subscribe mail * - * @param array $groups the list of group ids for subscribe - * @param array $params the list of email - * @param int $contactId Currently used during event registration/contribution. + * @param array $groups + * The list of group ids for subscribe. + * @param array $params + * The list of email. + * @param int $contactId + * Currently used during event registration/contribution. * Specifically to avoid linking group to wrong duplicate contact * during event registration. * @param string $context diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index d09de00252..9b6ee32869 100755 --- a/CRM/Mailing/Event/BAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/BAO/TrackableURLOpen.php @@ -45,8 +45,10 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * Track a click-through and return the URL to redirect. If the numbers * don't match up, return the base url. * - * @param int $queue_id The Queue Event ID of the clicker - * @param int $url_id The ID of the trackable URL + * @param int $queue_id + * The Queue Event ID of the clicker. + * @param int $url_id + * The ID of the trackable URL. * * @return string $url The redirection url, or base url on failure. * @static @@ -97,10 +99,14 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? - * @param int $url_id Optional ID of a url to filter on + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. + * @param int $url_id + * Optional ID of a url to filter on. * * @return int Number of rows in result set * @static @@ -194,8 +200,10 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track /** * Get tracked url count for each mailing for a given set of mailing IDs * - * @param int $mailingIDs IDs of the mailing (comma separated) - * @param int $contactID ID of the contact + * @param int $mailingIDs + * IDs of the mailing (comma separated). + * @param int $contactID + * ID of the contact. * * @return array Count per mailing ID * @static @@ -234,14 +242,22 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $url_id optional ID of a trackable URL to filter on - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array - * @param int $contact_id optional contact ID + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $url_id + * Optional ID of a trackable URL to filter on. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. + * @param int $contact_id + * Optional contact ID. * * @return array Result set * @static diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index 78a46dbb66..8da76798ce 100755 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -50,9 +50,12 @@ class CRM_Mailing_Event_BAO_Unsubscribe extends CRM_Mailing_Event_DAO_Unsubscrib /** * Unsubscribe a contact from the domain * - * @param int $job_id The job ID - * @param int $queue_id The Queue Event ID of the recipient - * @param string $hash The hash + * @param int $job_id + * The job ID. + * @param int $queue_id + * The Queue Event ID of the recipient. + * @param string $hash + * The hash. * * @return boolean Was the contact successfully unsubscribed? * @static @@ -112,10 +115,14 @@ WHERE email = %2 /** * Unsubscribe a contact from all groups that received this mailing * - * @param int $job_id The job ID - * @param int $queue_id The Queue Event ID of the recipient - * @param string $hash The hash - * @param boolean $return If true return the list of groups. + * @param int $job_id + * The job ID. + * @param int $queue_id + * The Queue Event ID of the recipient. + * @param string $hash + * The hash. + * @param bool $return + * If true return the list of groups. * * @return array|null $groups Array of all groups from which the contact was removed, or null if the queue event could not be found. * @static @@ -284,10 +291,14 @@ WHERE email = %2 * Send a reponse email informing the contact of the groups from which he * has been unsubscribed. * - * @param string $queue_id The queue event ID - * @param array $groups List of group IDs - * @param bool $is_domain Is this domain-level? - * @param int $job The job ID + * @param string $queue_id + * The queue event ID. + * @param array $groups + * List of group IDs. + * @param bool $is_domain + * Is this domain-level?. + * @param int $job + * The job ID. * * @return void * @static @@ -404,9 +415,12 @@ WHERE email = %2 /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of a job to filter on. + * @param bool $is_distinct + * Group by queue ID?. * * @param null $org_unsubscribe * @@ -467,12 +481,18 @@ WHERE email = %2 /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id + * ID of the mailing. + * @param int $job_id + * Optional ID of the job. + * @param bool $is_distinct + * Group by queue id?. + * @param int $offset + * Offset. + * @param int $rowCount + * Number of rows. + * @param array $sort + * Sort array. * * @param null $org_unsubscribe * @return array Result set diff --git a/CRM/Mailing/Form/Component.php b/CRM/Mailing/Form/Component.php index 805cb6ea9c..bf1aa5a5e7 100644 --- a/CRM/Mailing/Form/Component.php +++ b/CRM/Mailing/Form/Component.php @@ -149,7 +149,8 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { /** * Validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @param $files * @param $options diff --git a/CRM/Mailing/Form/Group.php b/CRM/Mailing/Form/Group.php index 17cbe95ff8..8c15509dd9 100644 --- a/CRM/Mailing/Form/Group.php +++ b/CRM/Mailing/Form/Group.php @@ -539,7 +539,8 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Mailing/Form/Schedule.php b/CRM/Mailing/Form/Schedule.php index f595d652e4..1abc69f586 100644 --- a/CRM/Mailing/Form/Schedule.php +++ b/CRM/Mailing/Form/Schedule.php @@ -186,7 +186,8 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { * Warning: if you make changes here, be sure to also make them in * Retry.php * - * @param array $params The form values + * @param array $params + * The form values. * * @param $files * @param $self diff --git a/CRM/Mailing/Form/Task.php b/CRM/Mailing/Form/Task.php index 0cbcb89898..8dd0360d3c 100644 --- a/CRM/Mailing/Form/Task.php +++ b/CRM/Mailing/Form/Task.php @@ -136,7 +136,8 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { * Simple shell that derived classes can call to add buttons to * the form with a customized title for the main Submit * - * @param string $title title of the main button + * @param string $title + * Title of the main button. * @param string $nextType * @param string $backType * @param bool $submitOnce diff --git a/CRM/Mailing/Form/Test.php b/CRM/Mailing/Form/Test.php index eb9331c59d..4370f960e4 100644 --- a/CRM/Mailing/Form/Test.php +++ b/CRM/Mailing/Form/Test.php @@ -171,8 +171,10 @@ class CRM_Mailing_Form_Test extends CRM_Core_Form { * Form rule to send out a test mailing. * * @param aray $testParams - * @param array $files Any files posted to the form - * @param array $self an current this object + * @param array $files + * Any files posted to the form. + * @param array $self + * An current this object. * * @return boolean true on successful SMTP handoff */ diff --git a/CRM/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php index afa6145f84..44257e2ab8 100644 --- a/CRM/Mailing/Form/Upload.php +++ b/CRM/Mailing/Form/Upload.php @@ -501,7 +501,8 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { /** * Validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @param $files * @param $self diff --git a/CRM/Mailing/MailStore.php b/CRM/Mailing/MailStore.php index f093dc3cd7..559bc2ff8c 100644 --- a/CRM/Mailing/MailStore.php +++ b/CRM/Mailing/MailStore.php @@ -39,7 +39,8 @@ class CRM_Mailing_MailStore { /** * Return the proper mail store implementation, based on config settings * - * @param string $name name of the settings set from civimail_mail_settings to use (null for default) + * @param string $name + * Name of the settings set from civimail_mail_settings to use (null for default). * * @throws Exception * @return object mail store implementation for processing CiviMail-bound emails @@ -98,7 +99,8 @@ class CRM_Mailing_MailStore { /** * Return the next X messages from the mail store * - * @param int $count number of messages to fetch (0 to fetch all) + * @param int $count + * Number of messages to fetch (0 to fetch all). * * @return array array of ezcMail objects */ @@ -139,7 +141,8 @@ class CRM_Mailing_MailStore { /** * Point to (and create if needed) a local Maildir for storing retrieved mail * - * @param string $name name of the Maildir + * @param string $name + * Name of the Maildir. * * @throws Exception * @return string path to the Maildir's cur directory diff --git a/CRM/Mailing/MailStore/Imap.php b/CRM/Mailing/MailStore/Imap.php index bfb3d047b4..6c238a65b1 100644 --- a/CRM/Mailing/MailStore/Imap.php +++ b/CRM/Mailing/MailStore/Imap.php @@ -44,11 +44,16 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { /** * Connect to the supplied IMAP server and make sure the two mailboxes exist * - * @param string $host host to connect to - * @param string $username authentication username - * @param string $password authentication password - * @param bool $ssl whether to use IMAP or IMAPS - * @param string $folder name of the inbox folder + * @param string $host + * Host to connect to. + * @param string $username + * Authentication username. + * @param string $password + * Authentication password. + * @param bool $ssl + * Whether to use IMAP or IMAPS. + * @param string $folder + * Name of the inbox folder. * * @return \CRM_Mailing_MailStore_Imap */ @@ -96,7 +101,8 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { /** * Move the specified message to the ignored folder * - * @param integer $nr number of the message to move + * @param int $nr + * Number of the message to move. * * @return void */ @@ -112,7 +118,8 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { /** * Move the specified message to the processed folder * - * @param integer $nr number of the message to move + * @param int $nr + * Number of the message to move. * * @return void */ diff --git a/CRM/Mailing/MailStore/Localdir.php b/CRM/Mailing/MailStore/Localdir.php index 0fc7d476e4..ef82e672f6 100644 --- a/CRM/Mailing/MailStore/Localdir.php +++ b/CRM/Mailing/MailStore/Localdir.php @@ -44,7 +44,8 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** * Connect to the supplied dir and make sure the two mail dirs exist * - * @param string $dir dir to operate upon + * @param string $dir + * Dir to operate upon. * * @return \CRM_Mailing_MailStore_Localdir */ @@ -59,7 +60,8 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { * Return the next X messages from the mail store * FIXME: in CiviCRM 2.2 this always returns all the emails * - * @param int $count number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all) + * @param int $count + * Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all). * * @return array array of ezcMail objects */ @@ -113,7 +115,8 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local ignore folder * - * @param integer $file file location of the message to fetch + * @param int $file + * File location of the message to fetch. * * @throws Exception * @return void @@ -131,7 +134,8 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local processed folder * - * @param integer $file file location of the message to fetch + * @param int $file + * File location of the message to fetch. * * @throws Exception * @return void diff --git a/CRM/Mailing/MailStore/Maildir.php b/CRM/Mailing/MailStore/Maildir.php index 17aab891d7..9a58bf0184 100644 --- a/CRM/Mailing/MailStore/Maildir.php +++ b/CRM/Mailing/MailStore/Maildir.php @@ -44,7 +44,8 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** * Connect to the supplied dir and make sure the two mail dirs exist * - * @param string $dir dir to operate upon + * @param string $dir + * Dir to operate upon. * * @return \CRM_Mailing_MailStore_Maildir */ @@ -59,7 +60,8 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { * Return the next X messages from the mail store * FIXME: in CiviCRM 2.2 this always returns all the emails * - * @param int $count number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all) + * @param int $count + * Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all). * * @return array array of ezcMail objects */ @@ -95,7 +97,8 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local ignore folder * - * @param integer $file file location of the message to fetch + * @param int $file + * File location of the message to fetch. * * @throws Exception * @return void @@ -113,7 +116,8 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local processed folder * - * @param integer $file file location of the message to fetch + * @param int $file + * File location of the message to fetch. * * @throws Exception * @return void diff --git a/CRM/Mailing/MailStore/Mbox.php b/CRM/Mailing/MailStore/Mbox.php index 1eab0d8f29..a0e6191bea 100644 --- a/CRM/Mailing/MailStore/Mbox.php +++ b/CRM/Mailing/MailStore/Mbox.php @@ -44,7 +44,8 @@ class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { /** * Connect to and lock the supplied file and make sure the two mail dirs exist * - * @param string $file mbox to operate upon + * @param string $file + * Mbox to operate upon. * * @return \CRM_Mailing_MailStore_Mbox */ @@ -77,7 +78,8 @@ class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local ignore folder * - * @param integer $nr number of the message to fetch + * @param int $nr + * Number of the message to fetch. * * @return void */ @@ -94,7 +96,8 @@ class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local processed folder * - * @param integer $nr number of the message to fetch + * @param int $nr + * Number of the message to fetch. * * @return void */ diff --git a/CRM/Mailing/MailStore/Pop3.php b/CRM/Mailing/MailStore/Pop3.php index 7004f66d11..bfe1f25fe0 100644 --- a/CRM/Mailing/MailStore/Pop3.php +++ b/CRM/Mailing/MailStore/Pop3.php @@ -44,10 +44,14 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore { /** * Connect to the supplied POP3 server and make sure the two mail dirs exist * - * @param string $host host to connect to - * @param string $username authentication username - * @param string $password authentication password - * @param bool $ssl whether to use POP3 or POP3S + * @param string $host + * Host to connect to. + * @param string $username + * Authentication username. + * @param string $password + * Authentication password. + * @param bool $ssl + * Whether to use POP3 or POP3S. * * @return \CRM_Mailing_MailStore_Pop3 */ @@ -67,7 +71,8 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local ignore folder * - * @param integer $nr number of the message to fetch + * @param int $nr + * Number of the message to fetch. * * @return void */ @@ -84,7 +89,8 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local processed folder * - * @param integer $nr number of the message to fetch + * @param int $nr + * Number of the message to fetch. * * @return void */ diff --git a/CRM/Mailing/PseudoConstant.php b/CRM/Mailing/PseudoConstant.php index 029b1e6e8b..40cf04595f 100644 --- a/CRM/Mailing/PseudoConstant.php +++ b/CRM/Mailing/PseudoConstant.php @@ -68,7 +68,8 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { /** * Get all the mailing components of a particular type * - * @param $type the type of component needed + * @param $type + * The type of component needed. * * @return array - array reference of all mailing components * @static @@ -107,8 +108,10 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { /** * Determine the default mailing component of a given type * - * @param $type the type of component needed - * @param $undefined the value to use if no default is defined + * @param $type + * The type of component needed. + * @param $undefined + * The value to use if no default is defined. * * @return integer -The ID of the default mailing component. * @static diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index 8c0fca37fb..92b4705783 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -95,8 +95,10 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -208,11 +210,16 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -413,7 +420,8 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index 60d5e5d71a..cd1293da8f 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -84,11 +84,16 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C /** * Class constructor * - * @param string $event The event type (queue/delivered/open...) - * @param boolean $distinct Count only distinct contact events? - * @param int $mailing ID of the mailing to query - * @param int $job ID of the job to query. If null, all jobs from $mailing are queried. - * @param int $url If the event type is a click-through, do we want only those from a specific url? + * @param string $event + * The event type (queue/delivered/open...). + * @param bool $distinct + * Count only distinct contact events?. + * @param int $mailing + * ID of the mailing to query. + * @param int $job + * ID of the job to query. If null, all jobs from $mailing are queried. + * @param int $url + * If the event type is a click-through, do we want only those from a specific url?. * * @return \CRM_Mailing_Selector_Event @access public @@ -130,8 +135,10 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -335,11 +342,16 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -415,7 +427,8 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index e6d1d05629..f073d6ae74 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -135,11 +135,15 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ /** * Class constructor * - * @param array $queryParams array of parameters for query + * @param array $queryParams + * Array of parameters for query. * @param \const|int $action - action of search basic or advanced. - * @param string $mailingClause if the caller wants to further restrict the search - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many mailing do we want returned + * @param string $mailingClause + * If the caller wants to further restrict the search. + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many mailing do we want returned. * * @param string $context * @param null $compContext @@ -258,11 +262,16 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -332,8 +341,10 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -394,7 +405,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ -- 2.25.1