*/
class MailAddress {
/**
- * @param string|User $address string with an email address, or a User object
- * @param string $name human-readable name if a string address is given
- * @param string $realName human-readable real name if a string address is given
+ * @param string|User $address String with an email address, or a User object
+ * @param string $name Human-readable name if a string address is given
+ * @param string $realName Human-readable real name if a string address is given
*/
function __construct( $address, $name = null, $realName = null ) {
if ( is_object( $address ) && $address instanceof User ) {
if ( $this->address ) {
if ( $this->name != '' && !wfIsWindows() ) {
global $wgEnotifUseRealName;
- $name = ( $wgEnotifUseRealName && $this->realName ) ? $this->realName : $this->name;
+ $name = ( $wgEnotifUseRealName && $this->realName !== '' ) ? $this->realName : $this->name;
$quoted = UserMailer::quotedPrintable( $name );
if ( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) {
$quoted = '"' . $quoted . '"';
* Collection of static functions for sending mail
*/
class UserMailer {
- static $mErrorString;
+ private static $mErrorString;
/**
* Send mail using a PEAR mailer
*
- * @param $mailer
- * @param $dest
- * @param $headers
- * @param $body
+ * @param UserMailer $mailer
+ * @param string $dest
+ * @param string $headers
+ * @param string $body
*
* @return Status
*/
* Note RFC2822 says newlines must be CRLF (\r\n)
* but php mail naively "corrects" it and requires \n for the "correction" to work
*
- * @return String
+ * @return string
*/
static function arrayToHeaderString( $headers, $endl = "\n" ) {
$strings = array();
/**
* Create a value suitable for the MessageId Header
*
- * @return String
+ * @return string
*/
static function makeMsgId() {
global $wgSMTP, $wgServer;
* array of parameters. It requires PEAR:Mail to do that.
* Otherwise it just uses the standard PHP 'mail' function.
*
- * @param $to MailAddress: recipient's email (or an array of them)
- * @param $from MailAddress: sender's email
- * @param string $subject email's subject.
- * @param string $body email's text or Array of two strings to be the text and html bodies
- * @param $replyto MailAddress: optional reply-to email (default: null).
- * @param string $contentType optional custom Content-Type (default: text/plain; charset=UTF-8)
+ * @param MailAddress $to Recipient's email (or an array of them)
+ * @param MailAddress $from Sender's email
+ * @param string $subject Email's subject.
+ * @param string $body Email's text or Array of two strings to be the text and html bodies
+ * @param MailAddress $replyto Optional reply-to email (default: null).
+ * @param string $contentType Optional custom Content-Type (default: text/plain; charset=UTF-8)
* @throws MWException
- * @return Status object
+ * @return Status
*/
- public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8' ) {
+ public static function send( $to, $from, $subject, $body, $replyto = null,
+ $contentType = 'text/plain; charset=UTF-8'
+ ) {
global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams, $wgAllowHTMLEmail;
$mime = null;
if ( !is_array( $to ) ) {
$body['text'] = str_replace( "\n", "\r\n", $body['text'] );
$body['html'] = str_replace( "\n", "\r\n", $body['html'] );
}
- $mime = new Mail_mime( array( 'eol' => $endl, 'text_charset' => 'UTF-8', 'html_charset' => 'UTF-8' ) );
+ $mime = new Mail_mime( array(
+ 'eol' => $endl,
+ 'text_charset' => 'UTF-8',
+ 'html_charset' => 'UTF-8'
+ ) );
$mime->setTXTBody( $body['text'] );
$mime->setHTMLBody( $body['html'] );
$body = $mime->get(); // must call get() before headers()
if ( $safeMode ) {
$sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers );
} else {
- $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
+ $sent = mail(
+ $recip,
+ self::quotedPrintable( $subject ),
+ $body,
+ $headers,
+ $wgAdditionalMailParams
+ );
}
}
} catch ( Exception $e ) {
/**
* Set the mail error message in self::$mErrorString
*
- * @param $code Integer: error number
- * @param string $string error message
+ * @param int $code Error number
+ * @param string $string Error message
*/
static function errorHandler( $code, $string ) {
self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
/**
* Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
- * @param $phrase string
+ * @param string $phrase
* @return string
*/
public static function rfc822Phrase( $phrase ) {
*
* May be deferred via the job queue.
*
- * @param $editor User object
- * @param $title Title object
- * @param $timestamp
- * @param $summary
- * @param $minorEdit
- * @param $oldid (default: false)
- * @param $pageStatus (default: 'changed')
+ * @param User $editor
+ * @param Title $title
+ * @param string $timestamp
+ * @param string $summary
+ * @param bool $minorEdit
+ * @param bool $oldid (default: false)
+ * @param string $pageStatus (default: 'changed')
*/
- public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false, $pageStatus = 'changed' ) {
+ public function notifyOnPageChange( $editor, $title, $timestamp, $summary,
+ $minorEdit, $oldid = false, $pageStatus = 'changed'
+ ) {
global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker, $wgEnotifMinorEdits,
$wgUsersNotifiedOnAllChanges, $wgEnotifUserTalk;
// Only send notification for non minor edits, unless $wgEnotifMinorEdits
if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
$isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
- if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
+ if ( $wgEnotifUserTalk
+ && $isUserTalkPage
+ && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
+ ) {
$sendEmail = true;
}
}
if ( !$sendEmail ) {
return;
}
+
if ( $wgEnotifUseJobQ ) {
$params = array(
'editor' => $editor->getName(),
$job = new EnotifNotifyJob( $title, $params );
JobQueueGroup::singleton()->push( $job );
} else {
- $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers, $pageStatus );
+ $this->actuallyNotifyOnPageChange(
+ $editor,
+ $title,
+ $timestamp,
+ $summary,
+ $minorEdit,
+ $oldid,
+ $watchers,
+ $pageStatus
+ );
}
}
* Send emails corresponding to the user $editor editing the page $title.
* Also updates wl_notificationtimestamp.
*
- * @param $editor User object
- * @param $title Title object
+ * @param User $editor
+ * @param Title $title
* @param string $timestamp Edit timestamp
* @param string $summary Edit summary
- * @param $minorEdit bool
+ * @param bool $minorEdit
* @param int $oldid Revision ID
- * @param array $watchers of user IDs
+ * @param array $watchers Array of user IDs
* @param string $pageStatus
* @throws MWException
*/
$userTalkId = false;
if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
-
- if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
+ if ( $wgEnotifUserTalk
+ && $isUserTalkPage
+ && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
+ ) {
$targetUser = User::newFromName( $title->getText() );
$this->compose( $targetUser );
$userTalkId = $targetUser->getId();
}
/**
- * @param $editor User
- * @param $title Title bool
- * @param $minorEdit
+ * @param User $editor
+ * @param Title $title
+ * @param bool $minorEdit
* @return bool
*/
private function canSendUserTalkEmail( $editor, $title, $minorEdit ) {
->inContentLanguage()->text();
}
$keys['$OLDID'] = $this->oldid;
- // @deprecated Remove in MediaWiki 1.23.
+ // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
$keys['$CHANGEDORCREATED'] = wfMessage( 'changed' )->inContentLanguage()->text();
} else {
# clear $OLDID placeholder in the message template
$keys['$OLDID'] = '';
$keys['$NEWPAGE'] = '';
- // @deprecated Remove in MediaWiki 1.23.
+ // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
$keys['$CHANGEDORCREATED'] = wfMessage( 'created' )->inContentLanguage()->text();
}
$keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
} else {
- $keys['$PAGEEDITOR'] = $wgEnotifUseRealName ? $this->editor->getRealName() : $this->editor->getName();
+ $keys['$PAGEEDITOR'] = $wgEnotifUseRealName && $this->editor->getRealName() !== ''
+ ? $this->editor->getRealName() : $this->editor->getName();
$emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $this->editor->getName() );
$keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalURL();
}
$keys['$PAGEEDITOR_WIKI'] = $this->editor->getUserPage()->getCanonicalURL();
+ $keys['$HELPPAGE'] = wfExpandUrl(
+ Skin::makeInternalOrExternalUrl( wfMessage( 'helppage' )->inContentLanguage()->text() )
+ );
# Replace this after transforming the message, bug 35019
$postTransformKeys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
* depending on settings.
*
* Call sendMails() to send any mails that were queued.
- * @param $user User
+ * @param User $user
*/
function compose( $user ) {
global $wgEnotifImpersonal;
* timestamp in proper timezone, etc) and sends it out.
* Returns true if the mail was sent successfully.
*
- * @param $watchingUser User object
- * @return Boolean
+ * @param User $watchingUser
+ * @return bool
* @private
*/
function sendPersonalised( $watchingUser ) {
global $wgContLang, $wgEnotifUseRealName;
// From the PHP manual:
- // Note: The to parameter cannot be an address in the form of "Something <someone@example.com>".
- // The mail command will not parse this properly while talking with the MTA.
+ // Note: The to parameter cannot be an address in the form of
+ // "Something <someone@example.com>". The mail command will not parse
+ // this properly while talking with the MTA.
$to = new MailAddress( $watchingUser );
# $PAGEEDITDATE is the time and date of the page change
array( '$WATCHINGUSERNAME',
'$PAGEEDITDATE',
'$PAGEEDITTIME' ),
- array( $wgEnotifUseRealName ? $watchingUser->getRealName() : $watchingUser->getName(),
+ array( $wgEnotifUseRealName && $watchingUser->getRealName() !== ''
+ ? $watchingUser->getRealName() : $watchingUser->getName(),
$wgContLang->userDate( $this->timestamp, $watchingUser ),
$wgContLang->userTime( $this->timestamp, $watchingUser ) ),
$this->body );
/**
* Same as sendPersonalised but does impersonal mail suitable for bulk
* mailing. Takes an array of MailAddress objects.
- * @param $addresses array
+ * @param MailAddress[] $addresses
* @return Status|null
*/
function sendImpersonal( $addresses ) {
dépôts / lhc / web / wiklou.git / blobdiff