1 关注者

抽象类 yii\mail\BaseMailer

继承yii\mail\BaseMailer » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\base\ViewContextInterface, yii\mail\MailerInterface
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/mail/BaseMailer.php

BaseMailer 作为基类,实现了 yii\mail\MailerInterface 所需的基本功能。

具体的子类应该专注于实现 sendMessage() 方法。

参见 yii\mail\BaseMessage 有关 BaseMailer 的更多详细信息和使用信息,请参阅 邮件教程指南

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$fileTransportCallback 可调用| $useFileTransport 为 true 时,由 send() 调用的 PHP 回调函数。 yii\mail\BaseMailer
$fileTransportPath 字符串 $useFileTransport 为 true 时,保存电子邮件消息的目录。 yii\mail\BaseMailer
$htmlLayout 字符串|布尔值 HTML 布局视图名称。 yii\mail\BaseMailer
$messageClass 字符串 createMessage() 创建的新消息实例的默认类名 yii\mail\BaseMailer
$messageConfig 数组 应应用于 createMessage()compose() 创建的任何新创建的电子邮件消息实例的配置。 yii\mail\BaseMailer
$textLayout 字符串|布尔值 文本布局视图名称。 yii\mail\BaseMailer
$useFileTransport 布尔值 是否将电子邮件消息保存为 $fileTransportPath 下的文件,而不是发送给实际的收件人。 yii\mail\BaseMailer
$view yii\web\View 视图实例。 yii\mail\BaseMailer
$viewPath 字符串 包含用于撰写邮件消息的视图文件的目录,默认值为 '@app/mail'。 yii\mail\BaseMailer

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
afterSend() 此方法在邮件发送后立即调用。 yii\mail\BaseMailer
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeSend() 此方法在邮件发送之前立即调用。 yii\mail\BaseMailer
behaviors() 返回此组件应表现的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示属性是否可读。 yii\base\Component
canSetProperty() 返回一个值,指示属性是否可设置。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
compose() 创建一个新的消息实例,并可选地通过视图渲染来编写其正文内容。 yii\mail\BaseMailer
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
generateMessageFileName() yii\mail\BaseMailer
getBehavior() 返回命名行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getView() yii\mail\BaseMailer
getViewPath() yii\mail\BaseMailer
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化对象。 yii\base\BaseObject
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
render() 使用可选参数和布局渲染指定的视图。 yii\mail\BaseMailer
send() 发送给定的电子邮件消息。 yii\mail\BaseMailer
sendMultiple() 一次发送多封邮件。 yii\mail\BaseMailer
setView() yii\mail\BaseMailer
setViewPath() yii\mail\BaseMailer
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承的方法

方法 描述 定义于
createMessage() 创建一个新的消息实例。 yii\mail\BaseMailer
createView() 从给定的配置创建视图实例。 yii\mail\BaseMailer
saveMessage() 将消息保存为 $fileTransportPath 下的文件。 yii\mail\BaseMailer
sendMessage() 发送指定的消息。 yii\mail\BaseMailer

事件

隐藏继承的事件

事件 类型 描述 定义于
EVENT_AFTER_SEND yii\mail\MailEvent 发送后立即引发的事件。 yii\mail\BaseMailer
EVENT_BEFORE_SEND yii\mail\MailEvent 发送之前立即引发的事件。 yii\mail\BaseMailer

属性详细信息

隐藏继承的属性

$fileTransportCallback 公共属性

send() 为 true 时,由 $useFileTransport 调用的 PHP 回调函数。回调函数应返回一个文件名,该文件名将用于保存电子邮件消息。如果未设置,则文件名将根据当前时间戳生成。

回调函数的签名为

function ($mailer, $message)
$fileTransportPath 公共属性

$useFileTransport 为 true 时,保存电子邮件消息的目录。

public string $fileTransportPath '@runtime/mail'
$htmlLayout 公共属性

HTML 布局视图名称。这是用于渲染 HTML 邮件正文的布局。此属性可以取以下值

  • 相对视图名称:相对于 $viewPath 的视图文件,例如,'layouts/html'。
  • 一个 路径别名:指定为路径别名的绝对视图文件路径,例如,'@app/mail/html'。
  • 布尔值 false:布局被禁用。
public string|boolean $htmlLayout 'layouts/html'
$messageClass 公共属性

createMessage() 创建的新消息实例的默认类名

public string $messageClass 'yii\mail\BaseMessage'
$messageConfig 公共属性

应该应用于任何新创建的电子邮件消息实例的配置,由 createMessage()compose() 创建。任何 yii\mail\MessageInterface 定义的有效属性都可以配置,例如 fromtosubjecttextBodyhtmlBody 等。

例如

[
    'charset' => 'UTF-8',
    'from' => '[email protected]',
    'bcc' => '[email protected]',
]
public array $messageConfig = []
$textLayout 公共属性

文本布局视图名称。这是用于渲染 TEXT 邮件正文的布局。请参考 $htmlLayout 以了解此属性可以取的可能值。

public string|boolean $textLayout 'layouts/text'
$useFileTransport 公共属性

是否将电子邮件消息保存为 $fileTransportPath 下的文件,而不是将它们发送给实际收件人。这通常在开发过程中用于调试目的。

另请参见 $fileTransportPath

public boolean $useFileTransport false
$view 公共属性

视图实例。请注意,此属性的类型在 getter 和 setter 中有所不同。有关详细信息,请参见 getView()setView()

public yii\web\View $view null
$viewPath 公共属性

包含用于撰写邮件消息的视图文件的目录,默认值为 '@app/mail'。

public string $viewPath null

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有命名的方法,如果可用则执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。

public mixed __call ( $name, $params )
$name 字符串

方法名称

$params 数组

方法参数

返回值 mixed

方法返回值

抛出 yii\base\UnknownMethodException

当调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它删除所有行为,因为它们附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果此方法在子类中被覆盖,建议

  • 构造函数的最后一个参数是一个配置数组,比如这里的 $config
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config 数组

将用于初始化对象属性的键值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property; 时会隐式调用。

另见 __set()

public mixed __get ( $name )
$name 字符串

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为空。

此方法将按以下顺序检查并相应地采取行动

  • 通过 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property) 时会隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name 字符串

属性名称或事件名称

返回值 布尔值

命名的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 通过 setter 定义的属性:设置属性值
  • 以 "on xyz" 格式的事件:将处理程序附加到事件 "xyz"
  • 以 "as xyz" 格式的行为:附加名为 "xyz" 的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会隐式调用。

另见 __get()

public void __set ( $name, $value )
$name 字符串

属性名称或事件名称

$value mixed

属性值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只读。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地采取行动

  • 通过 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property) 时会隐式调用。

另见 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name 字符串

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterSend() public method

此方法在邮件发送后立即调用。

您可以覆盖此方法,以根据邮件发送状态执行一些后期处理或记录。如果您覆盖此方法,请确保首先调用父实现。

public void afterSend ( $message, $isSuccessful )
$message yii\mail\MessageInterface
$isSuccessful 布尔值

                public function afterSend($message, $isSuccessful)
{
    $event = new MailEvent(['message' => $message, 'isSuccessful' => $isSuccessful]);
    $this->trigger(self::EVENT_AFTER_SEND, $event);
}

            
attachBehavior() public method

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另见 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name 字符串

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或用于创建行为的配置数组。

另见 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors 数组

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeSend() public method

此方法在邮件发送之前立即调用。

您可以覆盖此方法,以便对邮件进行最后一刻的准备。如果您覆盖此方法,请确保首先调用父实现。

public boolean beforeSend ( $message )
$message yii\mail\MessageInterface
返回值 布尔值

是否继续发送电子邮件。

                public function beforeSend($message)
{
    $event = new MailEvent(['message' => $message]);
    $this->trigger(self::EVENT_BEFORE_SEND, $event);
    return $event->isValid;
}

            
behaviors() public method

定义于: yii\base\Component::behaviors()

返回此组件应表现的行为列表。

子类可以覆盖此方法以指定他们想要表现的行为。

此方法的返回值应该是一个行为对象或配置数组,由行为名称索引。行为配置可以是一个指定行为类的字符串,也可以是一个以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

注意,行为类必须扩展 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,可以使用此名称,行为随后可以使用 getBehavior() 获取,或者使用 detachBehavior() 分离。匿名行为无法获取或分离。

在此方法中声明的行为将自动(按需)附加到组件。

public array behaviors ( )
返回值 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

定义于: yii\base\Component::canGetProperty()

返回一个值,指示属性是否可读。

属性可以读取,如果

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为真时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为真时)。

另见 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示属性是否可设置。

属性可以写入,如果

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为真时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另见 canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 起已弃用。在 PHP >=5.5 上,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 字符串

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
compose() 公共方法

创建一个新的消息实例,并可选地通过视图渲染来编写其正文内容。

public yii\mail\MessageInterface compose ( $view null, array $params = [] )
$view string|array|null

用于渲染邮件正文的视图。这可以是

  • 一个字符串,表示渲染电子邮件 HTML 正文的视图名称或 路径别名。在这种情况下,文本正文将通过对 HTML 正文应用 strip_tags() 来生成。
  • 具有 'html' 和/或 'text' 元素的数组。'html' 元素指的是渲染 HTML 正文的视图名称或路径别名,而 'text' 元素指的是渲染文本正文的视图名称或路径别名。例如,['html' => 'contact-html', 'text' => 'contact-text']
  • null,表示消息实例将返回,但没有正文内容。

要渲染的视图可以以下列格式之一指定

  • 路径别名(例如 "@app/mail/contact");
  • 位于 $viewPath 下的相对视图名称(例如 "contact")。
$params 数组

将在视图文件中提取并提供的参数(名称-值对)。

返回值 yii\mail\MessageInterface

消息实例。

                public function compose($view = null, array $params = [])
{
    $message = $this->createMessage();
    if ($view === null) {
        return $message;
    }
    if (!array_key_exists('message', $params)) {
        $params['message'] = $message;
    }
    $this->_message = $message;
    if (is_array($view)) {
        if (isset($view['html'])) {
            $html = $this->render($view['html'], $params, $this->htmlLayout);
        }
        if (isset($view['text'])) {
            $text = $this->render($view['text'], $params, $this->textLayout);
        }
    } else {
        $html = $this->render($view, $params, $this->htmlLayout);
    }
    $this->_message = null;
    if (isset($html)) {
        $message->setHtmlBody($html);
    }
    if (isset($text)) {
        $message->setTextBody($text);
    } elseif (isset($html)) {
        if (preg_match('~<body[^>]*>(.*?)</body>~is', $html, $match)) {
            $html = $match[1];
        }
        // remove style and script
        $html = preg_replace('~<((style|script))[^>]*>(.*?)</\1>~is', '', $html);
        // strip all HTML tags and decoded HTML entities
        $text = html_entity_decode(strip_tags($html), ENT_QUOTES | ENT_HTML5, Yii::$app ? Yii::$app->charset : 'UTF-8');
        // improve whitespace
        $text = preg_replace("~^[ \t]+~m", '', trim($text));
        $text = preg_replace('~\R\R+~mu', "\n\n", $text);
        $message->setTextBody($text);
    }
    return $message;
}

            
createMessage() 受保护方法

创建一个新的消息实例。

新创建的实例将使用 $messageConfig 指定的配置进行初始化。如果配置没有指定 'class',则将使用 $messageClass 作为新消息实例的类。

protected yii\mail\MessageInterface createMessage ( )
返回值 yii\mail\MessageInterface

消息实例。

                protected function createMessage()
{
    $config = $this->messageConfig;
    if (!array_key_exists('class', $config)) {
        $config['class'] = $this->messageClass;
    }
    $config['mailer'] = $this;
    return Yii::createObject($config);
}

            
createView() 受保护方法

从给定的配置创建视图实例。

protected yii\web\View createView ( array $config )
$config 数组

视图配置。

返回值 yii\web\View

视图实例。

                protected function createView(array $config)
{
    if (!array_key_exists('class', $config)) {
        $config['class'] = View::className();
    }
    return Yii::createObject($config);
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name 字符串

行为名称。

返回值 yii\base\Behavior|null

已分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
generateMessageFileName() 公共方法

public string generateMessageFileName ( )
返回值 字符串

$useFileTransport 为 true 时,保存消息的文件名。

                public function generateMessageFileName()
{
    $time = microtime(true);
    $timeInt = (int) $time;
    return date('Ymd-His-', $timeInt) . sprintf('%04d', (int) (($time - $timeInt) * 10000)) . '-' . sprintf('%04d', random_int(0, 10000)) . '.eml';
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name 字符串

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getView() 公共方法

public yii\web\View getView ( )
返回值 yii\web\View

视图实例。

                public function getView()
{
    if (!is_object($this->_view)) {
        $this->_view = $this->createView($this->_view);
    }
    return $this->_view;
}

            
getViewPath() public method

public string getViewPath ( )
返回值 字符串

包含用于撰写邮件消息的视图文件的目录,默认值为 '@app/mail'。

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->setViewPath('@app/mail');
    }
    return $this->_viewPath;
}

            
hasEventHandlers() public method

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名事件。

public boolean hasEventHandlers ( $name )
$name 字符串

事件名称

返回值 布尔值

是否为事件绑定了任何处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定义于: yii\base\Component::hasMethod()

返回一个值,指示方法是否已定义。

如果定义了一个方法

  • 该类具有与指定名称相同的方法
  • 附加的行为具有与给定名称相同的方法(当$checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name 字符串

属性名称

$checkBehaviors 布尔值

是否将行为的方法视为该组件的方法

返回值 布尔值

该方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定义于: yii\base\Component::hasProperty()

返回一个值,指示此组件是否定义了属性。

如果定义了一个属性

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为真时);
  • 附加的行为具有与给定名称相同的属性(当$checkBehaviors 为 true 时)。

另请参见

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

该属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束后调用,在对象使用给定的配置初始化后调用。

public void init ( )

                public function init()
{
}

            
off() public method

定义于: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与on() 相反。

注意:如果为事件名称传递了通配符模式,则只会删除使用此通配符注册的处理程序,而使用与此通配符匹配的普通名称注册的处理程序将保留。

另请参见 on().

public boolean off ( $name, $handler null )
$name 字符串

事件名称

$handler 可调用|

要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。

返回值 布尔值

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是一个有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中$event 是一个yii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参见 off().

public void on ( $name, $handler, $data null, $append true )
$name 字符串

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过yii\base\Event::$data 访问此数据。

$append 布尔值

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新处理程序将插入现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
render() public method

使用可选参数和布局渲染指定的视图。

该视图将使用$view 组件呈现。

public string render ( $view, $params = [], $layout false )
$view 字符串

视图名称或视图文件的路径别名

$params 数组

将在视图文件中提取并提供的参数(名称-值对)。

$layout 字符串|布尔值

布局视图名称或路径别名。如果为 false,则不会应用布局。

返回值 字符串

渲染结果。

                public function render($view, $params = [], $layout = false)
{
    $output = $this->getView()->render($view, $params, $this);
    if ($layout !== false) {
        return $this->getView()->render($layout, ['content' => $output, 'message' => $this->_message], $this);
    }
    return $output;
}

            
saveMessage() protected method

将消息保存为 $fileTransportPath 下的文件。

protected boolean saveMessage ( $message )
$message yii\mail\MessageInterface
返回值 布尔值

该消息是否保存成功

                protected function saveMessage($message)
{
    $path = Yii::getAlias($this->fileTransportPath);
    if (!is_dir($path)) {
        mkdir($path, 0777, true);
    }
    if ($this->fileTransportCallback !== null) {
        $file = $path . '/' . call_user_func($this->fileTransportCallback, $this, $message);
    } else {
        $file = $path . '/' . $this->generateMessageFileName();
    }
    file_put_contents($file, $message->toString());
    return true;
}

            
send() public method

发送给定的电子邮件消息。

此方法将记录有关发送电子邮件的消息。如果$useFileTransport 为 true,它将保存电子邮件作为文件,位于$fileTransportPath 下。否则,它将调用sendMessage() 将电子邮件发送给其收件人。子类应该使用实际的电子邮件发送逻辑实现sendMessage()

public boolean send ( $message )
$message yii\mail\MessageInterface

要发送的电子邮件消息实例

返回值 布尔值

该消息是否已成功发送

                public function send($message)
{
    if (!$this->beforeSend($message)) {
        return false;
    }
    $address = $message->getTo();
    if (is_array($address)) {
        $address = implode(', ', array_keys($address));
    }
    Yii::info('Sending email "' . $message->getSubject() . '" to "' . $address . '"', __METHOD__);
    if ($this->useFileTransport) {
        $isSuccessful = $this->saveMessage($message);
    } else {
        $isSuccessful = $this->sendMessage($message);
    }
    $this->afterSend($message, $isSuccessful);
    return $isSuccessful;
}

            
sendMessage() protected abstract method

发送指定的消息。

此方法应由子类使用实际的电子邮件发送逻辑实现。

受保护抽象 布尔值 sendMessage ( $message )
$message yii\mail\MessageInterface

要发送的消息

返回值 布尔值

消息是否成功发送

                abstract protected function sendMessage($message);

            
sendMultiple() 公共方法

一次发送多封邮件。

默认实现只是多次调用 send()。子类可以覆盖此方法来实现更高效的发送多封邮件的方式。

公共 整数 sendMultiple ( 数组 $messages )
$messages 数组

要发送的电子邮件列表。

返回值 整数

成功发送的消息数。

                public function sendMultiple(array $messages)
{
    $successCount = 0;
    foreach ($messages as $message) {
        if ($this->send($message)) {
            $successCount++;
        }
    }
    return $successCount;
}

            
setView() 公共方法

公共 setView ( $view )
$view 数组|yii\web\View

将用于渲染消息体的视图实例或其数组配置。

抛出 yii\base\InvalidConfigException

在无效参数上。

                public function setView($view)
{
    if (!is_array($view) && !is_object($view)) {
        throw new InvalidConfigException('"' . get_class($this) . '::view" should be either object or configuration array, "' . gettype($view) . '" given.');
    }
    $this->_view = $view;
}

            
setViewPath() 公共方法

公共 setViewPath ( $path )
$path 字符串

包含用于撰写邮件的视图文件的目录。这可以指定为绝对路径或 路径别名

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级别处理程序。

公共 trigger ( $name, yii\base\Event $event null )
$name 字符串

事件名称

$event yii\base\Event|

事件实例。如果未设置,将创建默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            

事件详情

隐藏继承的属性

EVENT_AFTER_SEND 类型为 yii\mail\MailEvent 的事件

发送后立即引发的事件。

EVENT_BEFORE_SEND 类型为 yii\mail\MailEvent 的事件

在发送之前引发的事件。您可以将 yii\mail\MailEvent::$isValid 设置为 false 来取消发送。