Page MenuHomeWickedGov Phorge
Files F4142076

CNBannerPager.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

CNBannerPager.php
View Options

<?php
// FIXME Unused? See T161907
// It's not unused, see Special:CentralNoticeBanners. Probably needs to be
// merged with TemplatePager.
use MediaWiki\HTMLForm\Field\HTMLInfoField;
use MediaWiki\Pager\ReverseChronologicalPager;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
class CNBannerPager extends ReverseChronologicalPager {
/** @var bool True if the form is to be created with editable elements */
private $editable = false;
/** @var string Space separated strings to filter banner titles on */
private $filter = '';
/** @var array[] HTMLFormFields to add to the results before every banner entry */
private $prependPrototypes = [];
/** @var array[] HTMLFormFields to add to the results after every banner entry */
private $appendPrototypes = [];
/** @var string 'Section' attribute to apply to the banner elements generated */
private $formSection = null;
/** @var SpecialCentralNoticeBanners the page on which we appear */
private $hostSpecialPage;
/**
* @param SpecialCentralNoticeBanners $hostSpecialPage
* @param string|null $formSection
* @param array $prependPrototypes
* @param array $appendPrototypes
* @param string $bannerFilter
* @param bool $editable
*/
public function __construct( SpecialCentralNoticeBanners $hostSpecialPage,
$formSection = null, $prependPrototypes = [],
$appendPrototypes = [], $bannerFilter = '', $editable = false
) {
$this->editable = $editable;
$this->filter = $bannerFilter;
// Set database before parent constructor to avoid setting it there
$this->mDb = CNDatabase::getReplicaDb();
parent::__construct();
$this->prependPrototypes = $prependPrototypes;
$this->appendPrototypes = $appendPrototypes;
$this->formSection = $formSection;
$this->hostSpecialPage = $hostSpecialPage;
// Override paging defaults
[ $this->mLimit, $this->mOffset ] = $this->mRequest->getLimitOffsetForUser(
$this->getUser(),
20,
''
);
$this->mLimitsShown = [ 20, 50, 100 ];
}
/**
* @inheritDoc
* @suppress PhanTypeMismatchDimAssignment
*/
public function getNavigationBar() {
if ( $this->mNavigationBar !== null ) {
return $this->mNavigationBar;
}
// Sets mNavigation bar with the default text which we will then wrap
parent::getNavigationBar();
// @phan-suppress-next-line PhanTypeMismatchPropertyProbablyReal
$this->mNavigationBar = [
'class' => HTMLBannerPagerNavigation::class,
'value' => $this->mNavigationBar
];
if ( $this->formSection ) {
// @phan-suppress-next-line PhanTypeMismatchPropertyProbablyReal
$this->mNavigationBar['section'] = $this->formSection;
}
// @phan-suppress-next-line PhanTypeMismatchReturnProbablyReal
return $this->mNavigationBar;
}
/**
* Set the database query to retrieve all the banners in the database
*
* @return array of query settings
*/
public function getQueryInfo() {
// When the filter comes in it is space delimited, so break that...
$likeArray = preg_split( '/\s/', $this->filter );
// ...and then insert all the wildcards between search terms
if ( !$likeArray ) {
$likeArray = [ $this->mDb->anyString() ];
} else {
$anyStringToken = $this->mDb->anyString();
$tempArray = [ $anyStringToken ];
foreach ( $likeArray as $likePart ) {
$tempArray[] = $likePart;
$tempArray[] = $anyStringToken;
}
$likeArray = $tempArray;
}
return [
'tables' => [ 'templates' => 'cn_templates' ],
'fields' => [ 'templates.tmp_name', 'templates.tmp_id', 'templates.tmp_is_template' ],
'conds' => [ $this->mDb->expr( 'templates.tmp_name', IExpression::LIKE, new LikeValue( ...$likeArray ) ) ],
];
}
/**
* Sort the banner list by tmp_id (generally equals reverse chronological)
*
* @return string
*/
public function getIndexField() {
return 'templates.tmp_id';
}
/**
* Generate the contents of the table pager; intended to be consumed by the HTMLForm
*
* @param stdClass $row database row
*
* @return array HTMLFormElement classes
* @suppress PhanParamSignatureMismatch
*/
public function formatRow( $row ) {
$retval = [];
$bannerId = $row->tmp_id;
$bannerName = $row->tmp_name;
// Add the prepend prototypes
foreach ( $this->prependPrototypes as $prototypeName => $prototypeValues ) {
$retval[ "{$prototypeName}-{$bannerName}" ] = $prototypeValues;
if ( array_key_exists( 'id', $prototypeValues ) ) {
$retval[ "{$prototypeName}-{$bannerId}" ][ 'id' ] .= "-$bannerName";
}
}
// Now do the banner
$rowText = BannerRenderer::linkToBanner( $bannerName );
if ( (bool)$row->tmp_is_template ) {
$rowText = implode( ' ', [
$rowText, $this->msg( "centralnotice-banner-template-info" )->escaped()
] );
}
$retval["cn-banner-list-element-$bannerId"] = [
'class' => HTMLInfoField::class,
'default' => $rowText . " (" . BannerRenderer::getPreviewLink( $bannerName ) . ")",
'raw' => true,
];
if ( $this->formSection ) {
$retval["cn-banner-list-element-$bannerId"]['section'] = $this->formSection;
}
// Append prototypes
foreach ( $this->appendPrototypes as $prototypeName => $prototypeValues ) {
$retval[ $prototypeName . "-$bannerId" ] = $prototypeValues;
if ( array_key_exists( 'id', $prototypeValues ) ) {
$retval[ $prototypeName . "-$bannerId" ][ 'id' ] .= "-$bannerId";
}
}
// Set the disabled attribute
if ( !$this->editable ) {
foreach ( $retval as &$prototypeValues ) {
$prototypeValues['disabled'] = true;
}
}
return $retval;
}
/**
* Get the formatted result list. Calls getStartBody(), formatRow() and
* getEndBody(), concatenates the results and returns them.
*
* @return array
* @suppress PhanParamSignatureMismatch
*/
public function getBody() {
if ( !$this->mQueryDone ) {
$this->doQuery();
}
if ( $this->mResult->numRows() ) {
# Do any special query batches before display
$this->doBatchLookups();
}
# Don't use any extra rows returned by the query
$numRows = min( $this->mResult->numRows(), $this->mLimit );
$retval = [];
if ( $numRows ) {
if ( $this->mIsBackwards ) {
for ( $i = $numRows - 1; $i >= 0; $i-- ) {
$this->mResult->seek( $i );
$row = $this->mResult->fetchObject();
$retval += $this->formatRow( $row );
}
} else {
$this->mResult->seek( 0 );
for ( $i = 0; $i < $numRows; $i++ ) {
$row = $this->mResult->fetchObject();
$retval += $this->formatRow( $row );
}
}
} else {
// TODO: empty value
}
return $retval;
}
/**
* @inheritDoc
*/
public function getDefaultQuery() {
parent::getDefaultQuery();
$filterQuery = $this->hostSpecialPage->getFilterUrlParamAsArray();
$this->mDefaultQuery = array_merge( $this->mDefaultQuery, $filterQuery );
return $this->mDefaultQuery;
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 16:12 (4 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ba/ee/59754384f1248a466274c6ab5940
Default Alt Text
CNBannerPager.php (6 KB)

Event Timeline