BlockActionInfo.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Block;
 
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use UnexpectedValueException;
 
class BlockActionInfo {
    private HookRunner $hookRunner;
 
    public const ACTION_UPLOAD = 1;
 
    public const ACTION_MOVE = 2;
 
    public const ACTION_CREATE = 3;
 
    private const CORE_BLOCK_ACTIONS = [
        'upload' => self::ACTION_UPLOAD,
        'move' => self::ACTION_MOVE,
        'create' => self::ACTION_CREATE,
    ];
 
    public function __construct( HookContainer $hookContainer ) {
        $this->hookRunner = new HookRunner( $hookContainer );
    }
 
    private $allBlockActions = null;
 
    public function getAllBlockActions(): array {
        // Don't run the hook multiple times in the same request
        if ( !$this->allBlockActions ) {
            $this->allBlockActions = self::CORE_BLOCK_ACTIONS;
            $this->hookRunner->onGetAllBlockActions( $this->allBlockActions );
        }
        if ( count( $this->allBlockActions ) !== count( array_unique( $this->allBlockActions ) ) ) {
            throw new UnexpectedValueException( 'Blockable action IDs not unique' );
        }
        return $this->allBlockActions;
    }
 
    public function getActionFromId( int $actionId ) {
        return array_search( $actionId, $this->getAllBlockActions() );
    }
 
    public function getIdFromAction( string $action ) {
        return $this->getAllBlockActions()[$action] ?? false;
    }
 
}