HTMLTagFilter.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use MediaWiki\ChangeTags\ChangeTags;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\MediaWikiServices;
 
class HTMLTagFilter extends HTMLFormField {
    protected $tagFilter;
 
    protected $activeOnly = ChangeTags::TAG_SET_ACTIVE_ONLY;
 
    protected $useAllTags = ChangeTags::USE_ALL_TAGS;
 
    public function __construct( $params ) {
        parent::__construct( $params );
 
        if ( array_key_exists( 'activeOnly', $params ) ) {
            $this->activeOnly = $params['activeOnly'];
        }
        if ( array_key_exists( 'useAllTags', $params ) ) {
            $this->useAllTags = $params['useAllTags'];
        }
    }
 
    private function buildTagFilter( string $value, string $format ): bool {
        $this->tagFilter = MediaWikiServices::getInstance()->getChangeTagsFormatter()->buildTagFilter(
            $value,
            $format,
            $this->mParent->getContext(),
            $this->activeOnly,
            $this->useAllTags
        );
        return (bool)$this->tagFilter;
    }
 
    public function getTableRow( $value ) {
        if ( $this->buildTagFilter( $value, 'other' ) ) {
            return parent::getTableRow( $value );
        }
        return '';
    }
 
    public function getDiv( $value ) {
        if ( $this->buildTagFilter( $value, 'other' ) ) {
            return parent::getDiv( $value );
        }
        return '';
    }
 
    public function getOOUI( $value ) {
        if ( $this->buildTagFilter( $value, 'ooui' ) ) {
            return parent::getOOUI( $value );
        }
        return new \OOUI\FieldLayout( new \OOUI\Widget() );
    }
 
    public function getCodex( $value ) {
        if ( $this->buildTagFilter( $value, 'codex' ) ) {
            return parent::getCodex( $value );
        }
        return '';
    }
 
    public function getInputHTML( $value ) {
        if ( $this->tagFilter ) {
            // we only need the select field, HTMLForm should handle the label
            return $this->tagFilter[1];
        }
        return '';
    }
 
    public function getInputOOUI( $value ) {
        if ( $this->tagFilter ) {
            // we only need the select field, HTMLForm should handle the label
            return $this->tagFilter[1];
        }
        return '';
    }
 
    protected function shouldInfuseOOUI() {
        return true;
    }
}
 
class_alias( HTMLTagFilter::class, 'HTMLTagFilter' );