Page MenuHomeWickedGov Phorge
Files F1431785

ApiBlockInfoTrait.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiBlockInfoTrait.php
View Options

<?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
*/
namespace MediaWiki\Api;
use MediaWiki\Block\Block;
use MediaWiki\Language\Language;
use MediaWiki\User\UserIdentity;
/**
* @ingroup API
*/
trait ApiBlockInfoTrait {
/**
* Get basic info about a given block
* @param Block $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
* - blockedtimestampformatted - blockedtimestamp, formatted for the current locale
* - blockexpiry - expiry time of the block
* - blockexpiryformatted - blockexpiry formatted for the current locale, omitted if infinite
* - blockexpiryrelative - relative time to blockexpiry (e.g. 'in 5 days'), omitted if infinite
* - blockpartial - block only applies to certain pages, namespaces and/or actions
* - systemblocktype - system block type, if any
* - blockcomponents - If the block is a composite block, this will be an array of block
* info arrays
*/
private function getBlockDetails(
Block $block,
$language = null
) {
return ( new ApiBlockInfoHelper )->getBlockDetails(
$block, $language ?? $this->getLanguage(), $this->getUser() );
}
/**
* Get the API error code, to be used in ApiMessage::create or ApiBase::dieWithError
* @param Block $block
* @return string
*/
private function getBlockCode( Block $block ): string {
return ( new ApiBlockInfoHelper )->getBlockCode( $block );
}
// region Methods required from ApiBase
/** @name Methods required from ApiBase
* @{
*/
/**
* @see IContextSource::getLanguage
* @return Language
*/
abstract public function getLanguage();
/**
* @see IContextSource::getUser
* @return UserIdentity
*/
abstract public function getUser();
/** @} */
// endregion -- end of methods required from ApiBase
}
/** @deprecated class alias since 1.43 */
class_alias( ApiBlockInfoTrait::class, 'ApiBlockInfoTrait' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 21:03 (1 d, 17 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a8/3d/8007444341b3d83f35e2e583a2d0
Default Alt Text
ApiBlockInfoTrait.php (2 KB)

Event Timeline