a3ef9bde23
The parameters are always the same, so there’s no point in requiring each API module to document them separately. Just reuse action=edit’s messages everywhere. (DiscussionTools [1] and VisualEditor [2] already do this without using the trait.) [1]:46a3e15dfb/includes/ApiDiscussionToolsEdit.php (491)[2]:b224d16b64/includes/ApiVisualEditorEdit.php (608)Bug: T357030 Change-Id: I1c8b6b48a0e0ddb4cd10a0279f8f75ba0ab5afc5
93 lines
2.4 KiB
PHP
93 lines
2.4 KiB
PHP
<?php
|
|
|
|
use MediaWiki\Api\ApiHookRunner;
|
|
use MediaWiki\Request\WebRequest;
|
|
use MediaWiki\User\UserIdentity;
|
|
use Wikimedia\ParamValidator\ParamValidator;
|
|
|
|
/**
|
|
* Methods needed by APIs that create a temporary user.
|
|
*
|
|
* This should only be added to classes that extend ApiBase.
|
|
*
|
|
* @ingroup API
|
|
* @since 1.42
|
|
*/
|
|
trait ApiCreateTempUserTrait {
|
|
/**
|
|
* Get any login redirect URL added by TempUserCreatedRedirectHook.
|
|
*
|
|
* @param array $params
|
|
* @param UserIdentity $savedTempUser
|
|
* @return string The redirect URL, or '' if none was added
|
|
*/
|
|
protected function getTempUserRedirectUrl(
|
|
array $params,
|
|
UserIdentity $savedTempUser
|
|
): string {
|
|
$returnToQuery = $params['returntoquery'];
|
|
$returnToAnchor = $params['returntoanchor'];
|
|
if ( str_starts_with( $returnToQuery, '?' ) ) {
|
|
// Remove leading '?' if provided (both ways work, but this is more common elsewhere)
|
|
$returnToQuery = substr( $returnToQuery, 1 );
|
|
}
|
|
if ( $returnToAnchor !== '' && !str_starts_with( $returnToAnchor, '#' ) ) {
|
|
// Add leading '#' if missing (it's required)
|
|
$returnToAnchor = '#' . $returnToAnchor;
|
|
}
|
|
$redirectUrl = '';
|
|
$this->getHookRunner()->onTempUserCreatedRedirect(
|
|
$this->getRequest()->getSession(),
|
|
$savedTempUser,
|
|
$params['returnto'] ?: '',
|
|
$returnToQuery,
|
|
$returnToAnchor,
|
|
$redirectUrl
|
|
);
|
|
return $redirectUrl;
|
|
}
|
|
|
|
/**
|
|
* Add params needed for TempUserCreatedRedirectHook.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getCreateTempUserParams(): array {
|
|
return [
|
|
'returnto' => [
|
|
ParamValidator::PARAM_TYPE => 'title',
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-edit-param-returnto',
|
|
],
|
|
'returntoquery' => [
|
|
ParamValidator::PARAM_TYPE => 'string',
|
|
ParamValidator::PARAM_DEFAULT => '',
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-edit-param-returntoquery',
|
|
],
|
|
'returntoanchor' => [
|
|
ParamValidator::PARAM_TYPE => 'string',
|
|
ParamValidator::PARAM_DEFAULT => '',
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-edit-param-returntoanchor',
|
|
],
|
|
];
|
|
}
|
|
|
|
// region Methods required from ApiBase
|
|
/** @name Methods required from ApiBase
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @see ApiBase::getHookRunner
|
|
* @return ApiHookRunner
|
|
*/
|
|
abstract protected function getHookRunner();
|
|
|
|
/**
|
|
* @see IContextSource::getRequest
|
|
* @return WebRequest
|
|
*/
|
|
abstract public function getRequest();
|
|
|
|
/** @} */
|
|
// endregion -- end of methods required from ApiBase
|
|
}
|