ApiQueryBlockInfoTrait.php File Reference

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Go to the source code of this file.

Functions
	addBlockInfoToQuery ( $showBlockInfo)
	Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information. More...
Methods required from ApiQueryBase
	addFields ( $fields)
	addJoinConds ( $conds)
	addTables ( $tables, $alias=null)
	addWhere ( $conds)
	getAuthority ()
	getDB ()

Variables
trait	ApiQueryBlockInfoTrait

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file ApiQueryBlockInfoTrait.php.

Function Documentation

addBlockInfoToQuery()

addBlockInfoToQuery (   $showBlockInfo )

private

Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information.

Parameters

bool

$showBlockInfo

Returns

void

Definition at line 38 of file ApiQueryBlockInfoTrait.php.

References addFields(), addJoinConds(), addTables(), addWhere(), getAuthority(), and getDB().

Referenced by ApiQueryAllUsers\execute(), ApiQueryUsers\execute(), and ApiQueryBase\showHiddenUsersAddBlockInfo().

addFields()

addFields (   $fields )

abstractprotected

See also

ApiQueryBase::addFields

Parameters

array | string

$fields

Referenced by addBlockInfoToQuery().

addJoinConds()

addJoinConds (   $conds )

abstractprotected

See also

ApiQueryBase::addJoinConds

Parameters

array

$conds

Referenced by addBlockInfoToQuery().

addTables()

addTables (   $tables,   $alias = null  )

abstractprotected

See also

ApiQueryBase::addTables

Parameters

string | array	$tables
string | null	$alias

Referenced by addBlockInfoToQuery().

addWhere()

addWhere (   $conds )

abstractprotected

See also

ApiQueryBase::addWhere

Parameters

string | array

$conds

Referenced by addBlockInfoToQuery().

getAuthority()

getAuthority ( )

abstract

See also

IContextSource::getAuthority

Returns

Authority

Referenced by addBlockInfoToQuery(), ContribsPager\doBatchLookups(), DeletedContribsPager\formatRevisionRow(), ImageListPager\formatValue(), EditPage\getPreloadedContent(), ContribsPager\getQueryInfo(), RollbackAction\handleRollbackRequest(), McrUndoAction\onSubmit(), UnwatchAction\onSubmit(), WatchAction\onSubmit(), HistoryAction\onView(), ImagePage\openShowImage(), InfoAction\pageInfo(), DeleteAction\runExecuteChecks(), Article\showMissingArticle(), Article\showPatrolFooter(), ImagePage\uploadLinksBox(), and Article\view().

getDB()

getDB ( )

abstractprotected

See also

ApiBase::getDB

Returns

IDatabase

Referenced by addBlockInfoToQuery(), and SiteStatsInit\doAllAndCommit().