MediaWiki  REL1_31
MailAddress.php
Go to the documentation of this file.
1 <?php
32 class MailAddress {
36  public $name;
37 
41  public $realName;
42 
46  public $address;
47 
53  function __construct( $address, $name = null, $realName = null ) {
54  if ( is_object( $address ) && $address instanceof User ) {
55  // Old calling format, now deprecated
56  wfDeprecated( __METHOD__ . ' with a User object', '1.24' );
57  $this->address = $address->getEmail();
58  $this->name = $address->getName();
59  $this->realName = $address->getRealName();
60  } else {
61  $this->address = strval( $address );
62  $this->name = strval( $name );
63  $this->realName = strval( $realName );
64  }
65  }
66 
74  public static function newFromUser( User $user ) {
75  return new MailAddress( $user->getEmail(), $user->getName(), $user->getRealName() );
76  }
77 
82  function toString() {
83  # PHP's mail() implementation under Windows is somewhat shite, and
84  # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
85  # so don't bother generating them
86  if ( $this->address ) {
87  if ( $this->name != '' && !wfIsWindows() ) {
89  $name = ( $wgEnotifUseRealName && $this->realName !== '' ) ? $this->realName : $this->name;
91  // Must only be quoted if string does not use =? encoding (T191931)
92  if ( $quoted === $name ) {
93  $quoted = '"' . addslashes( $quoted ) . '"';
94  }
95  return "$quoted <{$this->address}>";
96  } else {
97  return $this->address;
98  }
99  } else {
100  return "";
101  }
102  }
103 
104  function __toString() {
105  return $this->toString();
106  }
107 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
MailAddress\$name
string $name
Definition: MailAddress.php:36
UserMailer\quotedPrintable
static quotedPrintable( $string, $charset='')
Converts a string into quoted-printable format.
Definition: UserMailer.php:507
MailAddress\$realName
string $realName
Definition: MailAddress.php:41
MailAddress\toString
toString()
Return formatted and quoted address to insert into SMTP headers.
Definition: MailAddress.php:82
MailAddress\newFromUser
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Definition: MailAddress.php:74
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
MailAddress
Stores a single person's name and email address.
Definition: MailAddress.php:32
$wgEnotifUseRealName
$wgEnotifUseRealName
Use real name instead of username in e-mail "from" field.
Definition: DefaultSettings.php:1776
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
MailAddress\__construct
__construct( $address, $name=null, $realName=null)
Definition: MailAddress.php:53
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:2019
name
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
MailAddress\$address
string $address
Definition: MailAddress.php:46
MailAddress\__toString
__toString()
Definition: MailAddress.php:104