ApiBlockInfoHelper.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Block\AbstractBlock;
use MediaWiki\Block\Block;
use MediaWiki\Block\CompositeBlock;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\SystemBlock;
use MediaWiki\Language\Language;
use MediaWiki\User\UserIdentity;
use MediaWiki\Utils\MWTimestamp;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class ApiBlockInfoHelper {
 
    public function getBlockDetails(
        Block $block,
        Language $language,
        UserIdentity $user
    ) {
        $blocker = $block->getBlocker();
        $expiry = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
 
        $vals = [
            'blockid' => $block->getId(),
            'blockedby' => $blocker ? $blocker->getName() : '',
            'blockedbyid' => $blocker ? $blocker->getId() : 0,
            'blockreason' => $block->getReasonComment()->message->inLanguage( $language )->plain(),
            'blockedtimestamp' => wfTimestamp( TS::ISO_8601, $block->getTimestamp() ),
            'blockexpiry' => $expiry,
            'blockpartial' => !$block->isSitewide(),
            'blocknocreate' => $block->isCreateAccountBlocked(),
            'blockanononly' => !$block->isHardblock(),
        ];
 
        if ( $block instanceof AbstractBlock ) {
            $vals['blockemail'] = $block->isEmailBlocked();
            $vals['blockowntalk'] = !$block->isUsertalkEditAllowed();
            if ( $block->getHideBlock() ) {
                $vals['blockhidden'] = true;
            }
        }
        if ( $block instanceof DatabaseBlock ) {
            $vals['blockautoblocking'] = $block->isAutoblocking();
        }
 
        // Formatted timestamps
        $vals['blockedtimestampformatted'] = $language->formatExpiry(
            $block->getTimestamp(), true, 'infinity', $user
        );
        if ( $expiry !== 'infinite' ) {
            $vals['blockexpiryformatted'] = $language->formatExpiry(
                $expiry, true, 'infinity', $user
            );
            $vals['blockexpiryrelative'] = $language->getHumanTimestamp(
                new MWTimestamp( $expiry ), new MWTimestamp(), $user
            );
        }
 
        if ( $block instanceof SystemBlock ) {
            $vals['systemblocktype'] = $block->getSystemBlockType();
        }
 
        if ( $block instanceof CompositeBlock ) {
            $components = [];
            foreach ( $block->getOriginalBlocks() as $singleBlock ) {
                $components[] = $this->getBlockDetails( $singleBlock, $language, $user );
            }
            $vals['blockcomponents'] = $components;
        }
 
        return $vals;
    }
 
    public function getBlockCode( Block $block ): string {
        if ( $block instanceof DatabaseBlock && $block->getType() === Block::TYPE_AUTO ) {
            return 'autoblocked';
        }
        return 'blocked';
    }
 
}