BaseMessage.php 1.26 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

Paul Klimov committed
8
namespace yii\mail;
9 10 11 12 13

use yii\base\Object;
use Yii;

/**
Qiang Xue committed
14 15 16 17
 * BaseMessage serves as a base class that implements the [[send()]] method required by [[MessageInterface]].
 *
 * By default, [[send()]] will use the "mail" application component to send the current message.
 * The "mail" application component should be a mailer instance implementing [[MailerInterface]].
18 19 20 21 22 23
 *
 * @see BaseMailer
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
24
abstract class BaseMessage extends Object implements MessageInterface
25 26
{
	/**
Qiang Xue committed
27
	 * @inheritdoc
28
	 */
29
	public function send(MailerInterface $mailer = null)
30
	{
31 32 33 34
		if ($mailer === null) {
			$mailer = Yii::$app->getMail();
		}
		return $mailer->send($this);
35 36
	}

37 38 39 40 41 42 43 44 45 46 47
	/**
	 * PHP magic method that returns the string representation of this object.
	 * @return string the string representation of this object.
	 */
	public function __toString()
	{
		// __toString cannot throw exception
		// use trigger_error to bypass this limitation
		try {
			return $this->toString();
		} catch (\Exception $e) {
48
			trigger_error($e->getMessage() . "\n\n" . $e->getTraceAsString());
49 50 51
			return '';
		}
	}
52
}