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
84 lines
2.6 KiB
PHP
84 lines
2.6 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\AbstractBlock;
|
|
use MediaWiki\Block\SystemBlock;
|
|
|
|
/**
|
|
* @ingroup API
|
|
*/
|
|
trait ApiBlockInfoTrait {
|
|
|
|
/**
|
|
* Get basic info about a given block
|
|
* @param AbstractBlock $block
|
|
* @param Language|null $language
|
|
* @return array Array containing several keys:
|
|
* - blockid - ID of the block
|
|
* - blockedby - username of the blocker
|
|
* - blockedbyid - user ID of the blocker
|
|
* - blockreason - reason provided for the block
|
|
* - blockedtimestamp - timestamp for when the block was placed/modified
|
|
* - blockexpiry - expiry time of the block
|
|
* - blockpartial - block only applies to certain pages, namespaces and/or actions
|
|
* - systemblocktype - system block type, if any
|
|
*/
|
|
private function getBlockDetails(
|
|
AbstractBlock $block,
|
|
$language = null
|
|
) {
|
|
if ( $language === null ) {
|
|
$language = $this->getLanguage();
|
|
}
|
|
|
|
$vals = [];
|
|
$vals['blockid'] = $block->getId();
|
|
$vals['blockedby'] = $block->getByName();
|
|
$vals['blockedbyid'] = $block->getBy();
|
|
$vals['blockreason'] = $block->getReasonComment()
|
|
->message->inLanguage( $language )->plain();
|
|
$vals['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $block->getTimestamp() );
|
|
$vals['blockexpiry'] = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
|
|
$vals['blockpartial'] = !$block->isSitewide();
|
|
$vals['blocknocreate'] = $block->isCreateAccountBlocked();
|
|
$vals['blockanononly'] = !$block->isHardblock();
|
|
|
|
if ( $block instanceof SystemBlock ) {
|
|
$vals['systemblocktype'] = $block->getSystemBlockType();
|
|
}
|
|
|
|
return $vals;
|
|
}
|
|
|
|
// region Methods required from ApiBase
|
|
/** @name Methods required from ApiBase
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @see IContextSource::getLanguage
|
|
* @return Language
|
|
*/
|
|
abstract public function getLanguage();
|
|
|
|
/** @} */
|
|
// endregion -- end of methods required from ApiBase
|
|
|
|
}
|