mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-26 06:15:19 +08:00
Fixes #12055: Changed boolean
to bool
and integer
to int
in phpdoc
This commit is contained in:

committed by
Alexander Makarov

parent
940f7c7cd4
commit
4aa935e69e
@ -43,7 +43,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
const EVENT_AFTER_SEND = 'afterSend';
|
||||
|
||||
/**
|
||||
* @var string|boolean HTML layout view name. This is the layout used to render HTML mail body.
|
||||
* @var string|bool HTML layout view name. This is the layout used to render HTML mail body.
|
||||
* The property can take the following values:
|
||||
*
|
||||
* - a relative view name: a view file relative to [[viewPath]], e.g., 'layouts/html'.
|
||||
@ -52,7 +52,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
*/
|
||||
public $htmlLayout = 'layouts/html';
|
||||
/**
|
||||
* @var string|boolean text layout view name. This is the layout used to render TEXT mail body.
|
||||
* @var string|bool text layout view name. This is the layout used to render TEXT mail body.
|
||||
* Please refer to [[htmlLayout]] for possible values that this property can take.
|
||||
*/
|
||||
public $textLayout = 'layouts/text';
|
||||
@ -77,7 +77,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
*/
|
||||
public $messageClass = 'yii\mail\BaseMessage';
|
||||
/**
|
||||
* @var boolean whether to save email messages as files under [[fileTransportPath]] instead of sending them
|
||||
* @var bool whether to save email messages as files under [[fileTransportPath]] instead of sending them
|
||||
* to the actual recipients. This is usually used during development for debugging purpose.
|
||||
* @see fileTransportPath
|
||||
*/
|
||||
@ -242,7 +242,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
* Otherwise, it will call [[sendMessage()]] to send the email to its recipient(s).
|
||||
* Child classes should implement [[sendMessage()]] with the actual email sending logic.
|
||||
* @param MessageInterface $message email message instance to be sent
|
||||
* @return boolean whether the message has been sent successfully
|
||||
* @return bool whether the message has been sent successfully
|
||||
*/
|
||||
public function send($message)
|
||||
{
|
||||
@ -274,7 +274,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
* sending multiple messages.
|
||||
*
|
||||
* @param array $messages list of email messages, which should be sent.
|
||||
* @return integer number of messages that are successfully sent.
|
||||
* @return int number of messages that are successfully sent.
|
||||
*/
|
||||
public function sendMultiple(array $messages)
|
||||
{
|
||||
@ -293,7 +293,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
* The view will be rendered using the [[view]] component.
|
||||
* @param string $view the view name or the path alias of the view file.
|
||||
* @param array $params the parameters (name-value pairs) that will be extracted and made available in the view file.
|
||||
* @param string|boolean $layout layout view name or path alias. If false, no layout will be applied.
|
||||
* @param string|bool $layout layout view name or path alias. If false, no layout will be applied.
|
||||
* @return string the rendering result.
|
||||
*/
|
||||
public function render($view, $params = [], $layout = false)
|
||||
@ -310,14 +310,14 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
* Sends the specified message.
|
||||
* This method should be implemented by child classes with the actual email sending logic.
|
||||
* @param MessageInterface $message the message to be sent
|
||||
* @return boolean whether the message is sent successfully
|
||||
* @return bool whether the message is sent successfully
|
||||
*/
|
||||
abstract protected function sendMessage($message);
|
||||
|
||||
/**
|
||||
* Saves the message as a file under [[fileTransportPath]].
|
||||
* @param MessageInterface $message
|
||||
* @return boolean whether the message is saved successfully
|
||||
* @return bool whether the message is saved successfully
|
||||
*/
|
||||
protected function saveMessage($message)
|
||||
{
|
||||
@ -371,7 +371,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
* You may override this method to do last-minute preparation for the message.
|
||||
* If you override this method, please make sure you call the parent implementation first.
|
||||
* @param MessageInterface $message
|
||||
* @return boolean whether to continue sending an email.
|
||||
* @return bool whether to continue sending an email.
|
||||
*/
|
||||
public function beforeSend($message)
|
||||
{
|
||||
@ -386,7 +386,7 @@ abstract class BaseMailer extends Component implements MailerInterface, ViewCont
|
||||
* You may override this method to do some postprocessing or logging based on mail send status.
|
||||
* If you override this method, please make sure you call the parent implementation first.
|
||||
* @param MessageInterface $message
|
||||
* @param boolean $isSuccessful
|
||||
* @param bool $isSuccessful
|
||||
*/
|
||||
public function afterSend($message, $isSuccessful)
|
||||
{
|
||||
|
@ -36,7 +36,7 @@ abstract class BaseMessage extends Object implements MessageInterface
|
||||
* @param MailerInterface $mailer the mailer that should be used to send this message.
|
||||
* If no mailer is given it will first check if [[mailer]] is set and if not,
|
||||
* the "mail" application component will be used instead.
|
||||
* @return boolean whether this message is sent successfully.
|
||||
* @return bool whether this message is sent successfully.
|
||||
*/
|
||||
public function send(MailerInterface $mailer = null)
|
||||
{
|
||||
|
@ -24,11 +24,11 @@ class MailEvent extends Event
|
||||
*/
|
||||
public $message;
|
||||
/**
|
||||
* @var boolean if message was sent successfully.
|
||||
* @var bool if message was sent successfully.
|
||||
*/
|
||||
public $isSuccessful;
|
||||
/**
|
||||
* @var boolean whether to continue sending an email. Event handlers of
|
||||
* @var bool whether to continue sending an email. Event handlers of
|
||||
* [[\yii\mail\BaseMailer::EVENT_BEFORE_SEND]] may set this property to decide whether
|
||||
* to continue send or not.
|
||||
*/
|
||||
|
@ -48,7 +48,7 @@ interface MailerInterface
|
||||
/**
|
||||
* Sends the given email message.
|
||||
* @param MessageInterface $message email message instance to be sent
|
||||
* @return boolean whether the message has been sent successfully
|
||||
* @return bool whether the message has been sent successfully
|
||||
*/
|
||||
public function send($message);
|
||||
|
||||
@ -58,7 +58,7 @@ interface MailerInterface
|
||||
* This method may be implemented by some mailers which support more efficient way of sending multiple messages in the same batch.
|
||||
*
|
||||
* @param array $messages list of email messages, which should be sent.
|
||||
* @return integer number of messages that are successfully sent.
|
||||
* @return int number of messages that are successfully sent.
|
||||
*/
|
||||
public function sendMultiple(array $messages);
|
||||
}
|
||||
|
@ -206,7 +206,7 @@ interface MessageInterface
|
||||
* Sends this email message.
|
||||
* @param MailerInterface $mailer the mailer that should be used to send this message.
|
||||
* If null, the "mail" application component will be used instead.
|
||||
* @return boolean whether this message is sent successfully.
|
||||
* @return bool whether this message is sent successfully.
|
||||
*/
|
||||
public function send(MailerInterface $mailer = null);
|
||||
|
||||
|
Reference in New Issue
Block a user