MediaWiki  master
MediaWiki\Block\UserBlockCommandFactory Class Reference
Inheritance diagram for MediaWiki\Block\UserBlockCommandFactory:
Collaboration diagram for MediaWiki\Block\UserBlockCommandFactory:

Public Member Functions

 __construct (ServiceOptions $options, HookContainer $hookContainer, BlockPermissionCheckerFactory $blockPermissionCheckerFactory, BlockUtils $blockUtils, DatabaseBlockStore $blockStore, BlockRestrictionStore $blockRestrictionStore, UserFactory $userFactory, UserEditTracker $userEditTracker, LoggerInterface $logger, TitleFactory $titleFactory, BlockActionInfo $blockActionInfo)
 
 newBlockUser ( $target, Authority $performer, string $expiry, string $reason='', array $blockOptions=[], array $blockRestrictions=[], $tags=[])
 Create BlockUser. More...
 
 newUnblockUser ( $target, Authority $performer, string $reason, array $tags=[])
 

Public Attributes

const CONSTRUCTOR_OPTIONS = BlockUser::CONSTRUCTOR_OPTIONS
 

Detailed Description

Definition at line 33 of file UserBlockCommandFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\UserBlockCommandFactory::__construct ( ServiceOptions  $options,
HookContainer  $hookContainer,
BlockPermissionCheckerFactory  $blockPermissionCheckerFactory,
BlockUtils  $blockUtils,
DatabaseBlockStore  $blockStore,
BlockRestrictionStore  $blockRestrictionStore,
UserFactory  $userFactory,
UserEditTracker  $userEditTracker,
LoggerInterface  $logger,
TitleFactory  $titleFactory,
BlockActionInfo  $blockActionInfo 
)
Parameters
ServiceOptions$options
HookContainer$hookContainer
BlockPermissionCheckerFactory$blockPermissionCheckerFactory
BlockUtils$blockUtils
DatabaseBlockStore$blockStore
BlockRestrictionStore$blockRestrictionStore
UserFactory$userFactory
UserEditTracker$userEditTracker
LoggerInterface$logger
TitleFactory$titleFactory
BlockActionInfo$blockActionInfo

Definition at line 87 of file UserBlockCommandFactory.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ newBlockUser()

MediaWiki\Block\UserBlockCommandFactory::newBlockUser (   $target,
Authority  $performer,
string  $expiry,
string  $reason = '',
array  $blockOptions = [],
array  $blockRestrictions = [],
  $tags = [] 
)

Create BlockUser.

Parameters
string | UserIdentity$targetTarget of the block
Authority$performerPerformer of the block
string$expiryExpiry of the block (timestamp or 'infinity')
string$reasonReason of the block
array$blockOptions
array$blockRestrictions
array | null$tagsTags that should be assigned to the log entry
Returns
BlockUser

Implements MediaWiki\Block\BlockUserFactory.

Definition at line 128 of file UserBlockCommandFactory.php.

◆ newUnblockUser()

MediaWiki\Block\UserBlockCommandFactory::newUnblockUser (   $target,
Authority  $performer,
string  $reason,
array  $tags = [] 
)
Parameters
UserIdentity | string$target
Authority$performer
string$reason
string[]$tags
Returns
UnblockUser

Implements MediaWiki\Block\UnblockUserFactory.

Definition at line 171 of file UserBlockCommandFactory.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Block\UserBlockCommandFactory::CONSTRUCTOR_OPTIONS = BlockUser::CONSTRUCTOR_OPTIONS
Access: internal
Use only in ServiceWiring

Definition at line 72 of file UserBlockCommandFactory.php.


The documentation for this class was generated from the following file: