ApiCreateTempUserTrait.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Api\ApiHookRunner;
use MediaWiki\Request\WebRequest;
use MediaWiki\User\UserIdentity;
use Wikimedia\ParamValidator\ParamValidator;
 
trait ApiCreateTempUserTrait {
    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;
    }
 
    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
    abstract protected function getHookRunner();
 
    abstract public function getRequest();
 
    // endregion -- end of methods required from ApiBase
}