MediaWiki  1.28.1
Password.php
Go to the documentation of this file.
1 <?php
66 abstract class Password {
70  protected $factory;
71 
76  protected $hash;
77 
82  protected $config;
83 
96  final public function __construct( PasswordFactory $factory, array $config, $hash = null ) {
97  if ( !isset( $config['type'] ) ) {
98  throw new MWException( 'Password configuration must contain a type name.' );
99  }
100  $this->config = $config;
101  $this->factory = $factory;
102 
103  if ( $hash !== null && strlen( $hash ) >= 3 ) {
104  // Strip the type from the hash for parsing
105  $hash = substr( $hash, strpos( $hash, ':', 1 ) + 1 );
106  }
107 
108  $this->hash = $hash;
109  $this->parseHash( $hash );
110  }
111 
117  final public function getType() {
118  return $this->config['type'];
119  }
120 
128  protected function parseHash( $hash ) {
129  }
130 
136  public function needsUpdate() {
137  }
138 
149  public function equals( $other ) {
150  if ( !$other instanceof self ) {
151  // No need to use the factory because we're definitely making
152  // an object of the same type.
153  $obj = clone $this;
154  $obj->crypt( $other );
155  $other = $obj;
156  }
157 
158  return hash_equals( $this->toString(), $other->toString() );
159  }
160 
172  public function toString() {
173  return ':' . $this->config['type'] . ':' . $this->hash;
174  }
175 
185  abstract public function crypt( $password );
186 }
needsUpdate()
Determine if the hash needs to be updated.
Definition: Password.php:136
the array() calling protocol came about after MediaWiki 1.4rc1.
crypt($password)
Hash a password and store the result in this object.
parseHash($hash)
Perform any parsing necessary on the hash to see if the hash is valid and/or to perform logic for see...
Definition: Password.php:128
__construct(PasswordFactory $factory, array $config, $hash=null)
Construct the Password object using a string hash.
Definition: Password.php:96
getType()
Get the type name of the password.
Definition: Password.php:117
array $config
Array of configuration variables injected from the constructor.
Definition: Password.php:82
toString()
Convert this hash to a string that can be stored in the database.
Definition: Password.php:172
string $hash
String representation of the hash without the type.
Definition: Password.php:76
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
equals($other)
Compare one Password object to this object.
Definition: Password.php:149
PasswordFactory $factory
Factory that created the object.
Definition: Password.php:70