MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / auth / PasswordDomainAuthenticationRequest.php

diff --git a/includes/auth/PasswordDomainAuthenticationRequest.php b/includes/auth/PasswordDomainAuthenticationRequest.php
new file mode 100644 (file)
index 0000000..3db7e21
--- /dev/null
+++ b/includes/auth/PasswordDomainAuthenticationRequest.php
@@ -0,0 +1,85 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Auth
+ */
+
+namespace MediaWiki\Auth;
+
+/**
+ * This is a value object for authentication requests with a username, password, and domain
+ * @ingroup Auth
+ * @since 1.27
+ */
+class PasswordDomainAuthenticationRequest extends PasswordAuthenticationRequest {
+       /** @var string[] Domains available */
+       private $domainList;
+
+       /** @var string Domain */
+       public $domain = null;
+
+       /**
+        * @param string[] $domainList List of available domains
+        */
+       public function __construct( array $domainList ) {
+               $this->domainList = $domainList;
+       }
+
+       public function getFieldInfo() {
+               $ret = parent::getFieldInfo();
+
+               // Only add a domain field if we have the username field included
+               if ( isset( $ret['username'] ) ) {
+                       $ret['domain'] = [
+                               'type' => 'select',
+                               'options' => [],
+                               'label' => wfMessage( 'yourdomainname' ),
+                               'help' => wfMessage( 'authmanager-domain-help' ),
+                       ];
+                       foreach ( $this->domainList as $domain ) {
+                               $ret['domain']['options'][$domain] = new \RawMessage( '$1', [ $domain ] );
+                       }
+               }
+
+               return $ret;
+       }
+
+       public function describeCredentials() {
+               return [
+                       'provider' => wfMessage( 'authmanager-provider-password-domain' ),
+                       'account' => wfMessage(
+                               'authmanager-account-password-domain', [ $this->username, $this->domain ]
+                       ),
+               ];
+       }
+
+       /**
+        * @codeCoverageIgnore
+        * @param array $data
+        * @return AuthenticationRequest|static
+        */
+       public static function __set_state( $data ) {
+               $ret = new static( $data['domainList'] );
+               foreach ( $data as $k => $v ) {
+                       if ( $k !== 'domainList' ) {
+                               $ret->$k = $v;
+                       }
+               }
+               return $ret;
+       }
+}