CompositeBlock.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Block;
 
use IContextSource;
use Title;
 
class CompositeBlock extends AbstractBlock {
    private $originalBlocks;
 
    public function __construct( array $options = [] ) {
        parent::__construct( $options );
 
        $defaults = [
            'originalBlocks' => [],
        ];
 
        $options += $defaults;
 
        $this->originalBlocks = $options[ 'originalBlocks' ];
 
        $this->setHideName( $this->propHasValue( 'mHideName', true ) );
        $this->isSitewide( $this->propHasValue( 'isSitewide', true ) );
        $this->isEmailBlocked( $this->propHasValue( 'mBlockEmail', true ) );
        $this->isCreateAccountBlocked( $this->propHasValue( 'blockCreateAccount', true ) );
        $this->isUsertalkEditAllowed( !$this->propHasValue( 'allowUsertalk', false ) );
    }
 
    private function propHasValue( $prop, $value ) {
        foreach ( $this->originalBlocks as $block ) {
            if ( $block->$prop == $value ) {
                return true;
            }
        }
        return false;
    }
 
    private function methodReturnsValue( $method, $value, ...$params ) {
        foreach ( $this->originalBlocks as $block ) {
            if ( $block->$method( ...$params ) == $value ) {
                return true;
            }
        }
        return false;
    }
 
    public function getOriginalBlocks() {
        return $this->originalBlocks;
    }
 
    public function getExpiry() {
        $maxExpiry = null;
        foreach ( $this->originalBlocks as $block ) {
            $expiry = $block->getExpiry();
            if ( $maxExpiry === null || $expiry === '' || $expiry > $maxExpiry ) {
                $maxExpiry = $expiry;
            }
        }
        return $maxExpiry;
    }
 
    protected function getIds() {
        $ids = [];
        foreach ( $this->originalBlocks as $block ) {
            $id = $block->getId();
            if ( $id !== null ) {
                $ids[] = $id;
            }
        }
        return $ids;
    }
 
    public function getPermissionsError( IContextSource $context ) {
        $params = $this->getBlockErrorParams( $context );
 
        $ids = implode( ', ', array_map( function ( $id ) {
            return '#' . $id;
        }, $this->getIds() ) );
        if ( $ids === '' ) {
            $idsMsg = $context->msg( 'blockedtext-composite-no-ids' )->plain();
        } else {
            $idsMsg = $context->msg( 'blockedtext-composite-ids', [ $ids ] )->plain();
        }
 
        // TODO: Clean up error messages params so we don't have to do this (T227174)
        $params[ 4 ] = $idsMsg;
 
        $msg = 'blockedtext-composite';
 
        array_unshift( $params, $msg );
 
        return $params;
    }
 
    public function appliesToRight( $right ) {
        $isUnsure = false;
 
        foreach ( $this->originalBlocks as $block ) {
            $appliesToRight = $block->appliesToRight( $right );
 
            if ( $appliesToRight ) {
                return true;
            } elseif ( $appliesToRight === null ) {
                $isUnsure = true;
            }
        }
 
        return $isUnsure ? null : false;
    }
 
    public function appliesToUsertalk( Title $usertalk = null ) {
        return $this->methodReturnsValue( __FUNCTION__, true, $usertalk );
    }
 
    public function appliesToTitle( Title $title ) {
        return $this->methodReturnsValue( __FUNCTION__, true, $title );
    }
 
    public function appliesToNamespace( $ns ) {
        return $this->methodReturnsValue( __FUNCTION__, true, $ns );
    }
 
    public function appliesToPage( $pageId ) {
        return $this->methodReturnsValue( __FUNCTION__, true, $pageId );
    }
 
    public function appliesToPasswordReset() {
        return $this->methodReturnsValue( __FUNCTION__, true );
    }
 
}