<?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\Extension\CentralAuth;

use MediaWiki\Auth\AuthenticationRequest;

/**
 * Holds a token which can be exchanged for information describing the
 * outcome of central authentication. Passed via the return URL when
 * redirecting back from the login domain to the local wiki.
 *
 * @see CentralAuthRedirectingPrimaryAuthenticationProvider
 */
class CentralAuthReturnRequest extends AuthenticationRequest {

	/**
	 * Token store key used to pass information from RedirectingLoginHookHandler to
	 * CentralAuthRedirectingPrimaryAuthenticationProvider.
	 */
	public string $centralauthLoginToken;

	/**
	 * @inheritDoc
	 */
	public function getFieldInfo() {
		return [
			'centralauthLoginToken' => [
				'type' => 'string',
				'label' => wfMessage( 'centralauth-return-username-token' ),
				'help' => wfMessage( 'centralauth-return-username-token-help' ),
			],
		];
	}
}