HTMLRestrictionsField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Request\WebRequest;
use MWRestrictions;
 
class HTMLRestrictionsField extends HTMLFormField {
    protected const DEFAULT_ROWS = 5;
 
    private HTMLTextAreaField $ipField;
    private HTMLTagMultiselectField $pagesField;
 
    public function __construct( array $params ) {
        parent::__construct( $params );
        $this->ipField = new HTMLTextAreaField( [
            'parent' => $params['parent'],
            'fieldname' => $params['fieldname'] . '-ip',
            'rows' => self::DEFAULT_ROWS,
            'required' => $params['required'] ?? false,
            'help-message' => 'restrictionsfield-help',
            'label-message' => 'restrictionsfield-label',
        ] );
 
        // Cannot really use a TitlesMultiselect field as the pages could be
        // on other wikis!
        $this->pagesField = new HTMLTagMultiselectField( [
            'parent' => $params['parent'],
            'fieldname' => $params['fieldname'] . '-pages',
            'label-message' => 'restrictionsfields-pages-label',
            'help-message' => 'restrictionsfields-pages-help',
            'allowArbitrary' => true,
            'required' => false,
            'max' => 25,
        ] );
    }
 
    public function loadDataFromRequest( $request ) {
        if ( !$request->getCheck( $this->mName . '-ip' ) ) {
            return $this->getDefault();
        }
 
        $ipValue = rtrim( $request->getText( $this->mName . '-ip' ), "\r\n" );
        $ips = $ipValue === '' ? [] : explode( "\n", $ipValue );
        $pagesValue = $request->getText( $this->mName . '-pages' );
        $pageList = $pagesValue ? explode( "\n", $pagesValue ) : [];
        return MWRestrictions::newFromArray( [ 'IPAddresses' => $ips, 'Pages' => $pageList ] );
    }
 
    public function getDefault() {
        return parent::getDefault() ?? MWRestrictions::newDefault();
    }
 
    public function validate( $value, $alldata ) {
        if ( $this->isHidden( $alldata ) ) {
            return true;
        }
 
        if (
            isset( $this->mParams['required'] ) && $this->mParams['required'] !== false
            && !$value->toArray()['IPAddresses']
        ) {
            return $this->msg( 'htmlform-required' );
        }
 
        if ( !$value->validity->isGood() ) {
            $statusFormatter = MediaWikiServices::getInstance()->getFormatterFactory()->getStatusFormatter(
                $this->mParent->getContext()
            );
            return $statusFormatter->getMessage( $value->validity );
        }
 
        if ( $this->mValidationCallback !== null ) {
            return ( $this->mValidationCallback )( $value, $alldata, $this->mParent );
        }
 
        return true;
    }
 
    public function getInputHTML( $value ) {
        $ipValue = implode( "\n", $value->toArray()['IPAddresses'] );
        $pagesValue = implode( "\n", $value->toArray()['Pages'] ?? [] );
        return (
            $this->ipField->getDiv( $ipValue ) .
            $this->pagesField->getDiv( $pagesValue )
        );
    }
 
    public function getInputOOUI( $value ) {
        $ipValue = implode( "\n", $value->toArray()['IPAddresses'] );
        $pagesValue = implode( "\n", $value->toArray()['Pages'] ?? [] );
        return (
            $this->ipField->getOOUI( $ipValue ) .
            $this->pagesField->getOOUI( $pagesValue )
        );
    }
}
 
class_alias( HTMLRestrictionsField::class, 'HTMLRestrictionsField' );