MediaWiki  1.28.0
MailAddress.php
Go to the documentation of this file.
1 <?php
32 class MailAddress {
38  function __construct( $address, $name = null, $realName = null ) {
39  if ( is_object( $address ) && $address instanceof User ) {
40  // Old calling format, now deprecated
41  wfDeprecated( __METHOD__ . ' with a User object', '1.24' );
42  $this->address = $address->getEmail();
43  $this->name = $address->getName();
44  $this->realName = $address->getRealName();
45  } else {
46  $this->address = strval( $address );
47  $this->name = strval( $name );
48  $this->realName = strval( $realName );
49  }
50  }
51 
59  public static function newFromUser( User $user ) {
60  return new MailAddress( $user->getEmail(), $user->getName(), $user->getRealName() );
61  }
62 
67  function toString() {
68  # PHP's mail() implementation under Windows is somewhat shite, and
69  # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
70  # so don't bother generating them
71  if ( $this->address ) {
72  if ( $this->name != '' && !wfIsWindows() ) {
74  $name = ( $wgEnotifUseRealName && $this->realName !== '' ) ? $this->realName : $this->name;
76  if ( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) {
77  $quoted = '"' . $quoted . '"';
78  }
79  return "$quoted <{$this->address}>";
80  } else {
81  return $this->address;
82  }
83  } else {
84  return "";
85  }
86  }
87 
88  function __toString() {
89  return $this->toString();
90  }
91 }
getEmail()
Get the user's e-mail address.
Definition: User.php:2647
$wgEnotifUseRealName
Use real name instead of username in e-mail "from" field.
getRealName()
Get the user's real name.
Definition: User.php:2739
__construct($address, $name=null, $realName=null)
Definition: MailAddress.php:38
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfIsWindows()
Check if the operating system is Windows.
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2108
Stores a single person's name and email address.
Definition: MailAddress.php:32
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
toString()
Return formatted and quoted address to insert into SMTP headers.
Definition: MailAddress.php:67
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Definition: MailAddress.php:59
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 local account $user
Definition: hooks.txt:242
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:35
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
static quotedPrintable($string, $charset= '')
Converts a string into quoted-printable format.
Definition: UserMailer.php:478
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300