ApiQueryBlockInfoTrait.php

Go to the documentation of this file.

<?php
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Permissions\Authority;
use Wikimedia\Rdbms\IDatabase;
 
trait ApiQueryBlockInfoTrait {
    use ApiBlockInfoTrait;
 
    private function addBlockInfoToQuery( $showBlockInfo ) {
        $db = $this->getDB();
 
        if ( $showBlockInfo ) {
            $queryInfo = DatabaseBlock::getQueryInfo();
        } else {
            $queryInfo = [
                'tables' => [ 'ipblocks' ],
                'fields' => [ 'ipb_deleted' ],
                'joins' => [],
            ];
        }
 
        $this->addTables( [ 'blk' => $queryInfo['tables'] ] );
        $this->addFields( $queryInfo['fields'] );
        $this->addJoinConds( $queryInfo['joins'] );
        $this->addJoinConds( [
            'blk' => [ 'LEFT JOIN', [
                'ipb_user=user_id',
                'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ),
            ] ],
        ] );
 
        // Don't show hidden names
        if ( !$this->getAuthority()->isAllowed( 'hideuser' ) ) {
            $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
        }
    }
 
    /***************************************************************************/
    // region   Methods required from ApiQueryBase
    abstract protected function getDB();
 
    abstract public function getAuthority();
 
    abstract protected function addTables( $tables, $alias = null );
 
    abstract protected function addFields( $fields );
 
    abstract protected function addWhere( $conds );
 
    abstract protected function addJoinConds( $conds );
 
    // endregion -- end of methods required from ApiQueryBase
 
}