<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
/**
* Class constructor
*/
- function __construct() {
+ public function __construct() {
parent::__construct();
}
/**
* 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
*
- * @return object|null The mailing object, or null on failure
- * @access public
- * @static
+ * @return object|null
+ * The mailing object, or null on failure
*/
public static function &reply($job_id, $queue_id, $hash, $replyto = NULL) {
/* First make sure there's a matching queue event */
/**
* 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
- * @access public
- * @static
*/
public static function send($queue_id, &$mailing, &$bodyTxt, $replyto, &$bodyHTML = NULL, &$fullEmail = NULL) {
$domain = CRM_Core_BAO_Domain::getDomain();
/**
* 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
- * @access private
- * @static
*/
private static function autoRespond(&$mailing, $queue_id, $replyto) {
$config = CRM_Core_Config::singleton();
/**
* 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
- * @access public
- * @static
+ * @return int
+ * Number of rows in result set
*/
- public static function getTotalCount($mailing_id, $job_id = NULL,
+ public static function getTotalCount(
+ $mailing_id, $job_id = NULL,
$is_distinct = FALSE
) {
$dao = new CRM_Core_DAO();
/**
* 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
- * @access public
- * @static
+ * @return array
+ * Result set
*/
- public static function &getRows($mailing_id, $job_id = NULL,
+ public static function &getRows(
+ $mailing_id, $job_id = NULL,
$is_distinct = FALSE, $offset = NULL, $rowCount = NULL, $sort = NULL
) {
return $results;
}
}
-