Commit eb3b2f45 by Qiang Xue

refactored EmailTarget with the new mailer interfaces.

parent c22409e3
...@@ -519,12 +519,14 @@ class BaseYii ...@@ -519,12 +519,14 @@ class BaseYii
* Configures an object with the initial property values. * Configures an object with the initial property values.
* @param object $object the object to be configured * @param object $object the object to be configured
* @param array $properties the property initial values given in terms of name-value pairs. * @param array $properties the property initial values given in terms of name-value pairs.
* @return object the object itself
*/ */
public static function configure($object, $properties) public static function configure($object, $properties)
{ {
foreach ($properties as $name => $value) { foreach ($properties as $name => $value) {
$object->$name = $value; $object->$name = $value;
} }
return $object;
} }
/** /**
......
...@@ -7,6 +7,10 @@ ...@@ -7,6 +7,10 @@
namespace yii\log; namespace yii\log;
use Yii;
use yii\base\InvalidConfigException;
use yii\mail\MailerInterface;
/** /**
* EmailTarget sends selected log messages to the specified email addresses. * EmailTarget sends selected log messages to the specified email addresses.
* *
...@@ -20,51 +24,57 @@ namespace yii\log; ...@@ -20,51 +24,57 @@ namespace yii\log;
class EmailTarget extends Target class EmailTarget extends Target
{ {
/** /**
* @var array list of destination email addresses. * @var array the configuration array for creating a [[\yii\mail\MessageInterface|message]] object.
*/ * Note that the "to" option must be set, which specifies the destination email address(es).
public $emails = [];
/**
* @var string email subject
*/ */
public $subject; public $message = [];
/** /**
* @var string email sent-from address * @var MailerInterface|string the mailer object or the application component ID of the mailer object.
* After the EmailTarget object is created, if you want to change this property, you should only assign it
* with a mailer object.
*/ */
public $sentFrom; public $mail = 'mail';
/** /**
* @var array list of additional headers to use when sending an email. * @inheritdoc
*/ */
public $headers = []; public function init()
{
parent::init();
if (empty($this->message['to'])) {
throw new InvalidConfigException('The "to" option must be set for EmailTarget::message.');
}
if (empty($this->message['subject'])) {
$this->message['subject'] = Yii::t('yii', 'Application Log');
}
if (is_string($this->mail)) {
$this->mail = Yii::$app->getComponent($this->mail);
}
if (!$this->mail instanceof MailerInterface) {
throw new InvalidConfigException("EmailTarget::mailer must be either a mailer object or the application component ID of a mailer object.");
}
}
/** /**
* Sends log messages to specified email addresses. * Sends log messages to specified email addresses.
*/ */
public function export() public function export()
{ {
$body = ''; $message = $this->mail->compose();
foreach ($this->messages as $message) { Yii::configure($message, $this->message);
$body .= $this->formatMessage($message); $this->composeMessage($message);
} $this->mail->send($message);
$body = wordwrap($body, 70);
$subject = $this->subject === null ? \Yii::t('yii', 'Application Log') : $this->subject;
foreach ($this->emails as $email) {
$this->sendEmail($subject, $body, $email, $this->sentFrom, $this->headers);
}
} }
/** /**
* Sends an email. * Composes the given mail message with body content.
* @param string $subject email subject * The default implementation fills the text body of the message with the log messages.
* @param string $body email body * @param \yii\mail\MessageInterface $message
* @param string $sentTo sent-to email address
* @param string $sentFrom sent-from email address
* @param array $headers additional headers to be used when sending the email
*/ */
protected function sendEmail($subject, $body, $sentTo, $sentFrom, $headers) protected function composeMessage($message)
{ {
if ($sentFrom !== null) { $messages = array_map([$this, 'formatMessage'], $this->messages);
$headers[] = "From: {$sentFrom}"; $body = wordwrap(implode("\n", $messages), 70);
} $message->setTextBody($body);
mail($sentTo, $subject, $body, implode("\r\n", $headers));
} }
} }
...@@ -233,6 +233,6 @@ abstract class Target extends Component ...@@ -233,6 +233,6 @@ abstract class Target extends Component
$text = var_export($text, true); $text = var_export($text, true);
} }
$ip = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1'; $ip = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1';
return date('Y/m/d H:i:s', $timestamp) . " [$ip] [$level] [$category] $text\n"; return date('Y/m/d H:i:s', $timestamp) . " [$ip] [$level] [$category] $text";
} }
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment