wiki.techinc.nl/includes/user/TempUser/TempUserConfig.php
Tim Starling 54ca544726 Add convenience method TempUserCreator::shouldAutoCreate()
Factor out common concept originating in EditPage but since duplicated.

Change-Id: I5f5b75a7da9a40a6cc3041d3d6192d2d747b9f57
2023-05-12 15:31:11 +10:00

68 lines
1.5 KiB
PHP

<?php
namespace MediaWiki\User\TempUser;
use MediaWiki\Permissions\Authority;
/**
* Interface for temporary user creation config and name matching.
*
* This is separate from TempUserCreator to avoid dependency loops during
* service construction, since TempUserCreator needs UserNameUtils which
* needs TempUserConfig.
*
* @since 1.39
*/
interface TempUserConfig {
/**
* Is temp user creation enabled?
*
* @return bool
*/
public function isEnabled();
/**
* Is the action valid for user auto-creation?
*
* @param string $action
* @return bool
*/
public function isAutoCreateAction( string $action );
/**
* Should/would auto-create be performed if the user attempts to perform
* the given action?
*
* @since 1.41
* @param Authority $authority
* @param string $action
* @return bool
*/
public function shouldAutoCreate( Authority $authority, string $action );
/**
* Does the name match the configured pattern indicating that it is a
* temporary auto-created user?
*
* @param string $name
* @return bool
*/
public function isTempName( string $name );
/**
* Does the name match a configured pattern which indicates that it
* conflicts with temporary user names? Should manual user creation
* be denied?
*
* @param string $name
* @return mixed
*/
public function isReservedName( string $name );
/**
* Get a placeholder name which matches the reserved prefix
*
* @return string
*/
public function getPlaceholderName(): string;
}