9af96ef4c7
PHPStorm can use custom folding regions defined in either the
VisualStudio style or the NetBeans style. The VisualStudio style is more
pleasing to the eye and also works as a vim foldmarker. So get rid of
the previous vim foldmarkers, and use region/endregion.
region/endregion need to be in a single-line comment which is not a doc
comment, and the rest of the comment is used as a region heading (by
both PHPStorm and vim). So to retain Doxygen @name tags, it is
necessary to repeat the section heading, once in a @name and once in a
region. Establish a standard style for this, with a divider and three
spaces before the heading, to better set off the heading name in plain
text.
Besides being the previous vim foldmarker, @{ is also a Doxygen
grouping command. However, almost all prior usages of @{ ... @} in this
sense were broken for one reason or another. It's necessary for the @{
to be in a doc comment, and DISTRIBUTE_GROUP_DOC doesn't work if any of
the individual members in the group are separately documented.
@name alone is sufficient to create a Doxygen section when the sections
are adjacent, but if there is ungrouped content after the section, it
is necessary to use @{ ... @} to avoid having the Doxygen group run on.
So I retained, fixed or added @{ ... @} in certain cases.
I wasn't able to test the changes to the trait documentation in Doxygen
since trait syntax is not recognised and the output is badly broken.
Change-Id: I7d819fdb376c861f40bfc01aed74cd3706141b20
116 lines
3 KiB
PHP
116 lines
3 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Block\DatabaseBlock;
|
|
use MediaWiki\Permissions\PermissionManager;
|
|
use Wikimedia\Rdbms\IDatabase;
|
|
|
|
/**
|
|
* @ingroup API
|
|
*/
|
|
trait ApiQueryBlockInfoTrait {
|
|
use ApiBlockInfoTrait;
|
|
|
|
/**
|
|
* Filters hidden users (where the user doesn't have the right to view them)
|
|
* Also adds relevant block information
|
|
*
|
|
* @param bool $showBlockInfo
|
|
* @return void
|
|
*/
|
|
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->getPermissionManager()->userHasRight( $this->getUser(), 'hideuser' ) ) {
|
|
$this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
|
|
}
|
|
}
|
|
|
|
/***************************************************************************/
|
|
// region Methods required from ApiQueryBase
|
|
/** @name Methods required from ApiQueryBase */
|
|
|
|
/**
|
|
* @see ApiBase::getDB
|
|
* @return IDatabase
|
|
*/
|
|
abstract protected function getDB();
|
|
|
|
/**
|
|
* @see ApiBase::getPermissionManager
|
|
* @return PermissionManager
|
|
*/
|
|
abstract protected function getPermissionManager(): PermissionManager;
|
|
|
|
/**
|
|
* @see IContextSource::getUser
|
|
* @return User
|
|
*/
|
|
abstract public function getUser();
|
|
|
|
/**
|
|
* @see ApiQueryBase::addTables
|
|
* @param string|array $tables
|
|
* @param string|null $alias
|
|
*/
|
|
abstract protected function addTables( $tables, $alias = null );
|
|
|
|
/**
|
|
* @see ApiQueryBase::addFields
|
|
* @param array|string $fields
|
|
*/
|
|
abstract protected function addFields( $fields );
|
|
|
|
/**
|
|
* @see ApiQueryBase::addWhere
|
|
* @param string|array $conds
|
|
*/
|
|
abstract protected function addWhere( $conds );
|
|
|
|
/**
|
|
* @see ApiQueryBase::addJoinConds
|
|
* @param array $conds
|
|
*/
|
|
abstract protected function addJoinConds( $conds );
|
|
|
|
// endregion -- end of methods required from ApiQueryBase
|
|
|
|
}
|