TitleDef.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\ParamValidator\TypeDef;
 
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Title\TitleFactory;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\Callbacks;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef;
 
class TitleDef extends TypeDef {
 
    public const PARAM_MUST_EXIST = 'param-must-exist';
 
    public const PARAM_RETURN_OBJECT = 'param-return-object';
 
    private $titleFactory;
 
    public function __construct( Callbacks $callbacks, TitleFactory $titleFactory ) {
        parent::__construct( $callbacks );
        $this->titleFactory = $titleFactory;
    }
 
    public function validate( $name, $value, array $settings, array $options ) {
        $mustExist = !empty( $settings[self::PARAM_MUST_EXIST] );
        $returnObject = !empty( $settings[self::PARAM_RETURN_OBJECT] );
 
        $this->failIfNotString( $name, $value, $settings, $options );
 
        $title = $this->titleFactory->newFromText( $value );
 
        if ( !$title ) {
            // Message used: paramvalidator-badtitle
            $this->failure( 'badtitle', $name, $value, $settings, $options );
        } elseif ( $mustExist && !$title->exists() ) {
            // Message used: paramvalidator-missingtitle
            $this->failure( 'missingtitle', $name, $value, $settings, $options );
        }
 
        if ( $returnObject ) {
            return $title->getTitleValue();
        } else {
            return $title->getPrefixedText();
        }
    }
 
    public function stringifyValue( $name, $value, array $settings, array $options ) {
        if ( $value instanceof LinkTarget ) {
            return $this->titleFactory->newFromLinkTarget( $value )->getPrefixedText();
        }
        return parent::stringifyValue( $name, $value, $settings, $options );
    }
 
    public function checkSettings( string $name, $settings, array $options, array $ret ): array {
        $ret = parent::checkSettings( $name, $settings, $options, $ret );
 
        $ret['allowedKeys'][] = self::PARAM_MUST_EXIST;
        $ret['allowedKeys'][] = self::PARAM_RETURN_OBJECT;
 
        if ( !is_bool( $settings[self::PARAM_MUST_EXIST] ?? false ) ) {
            $ret['issues'][self::PARAM_MUST_EXIST] = 'PARAM_MUST_EXIST must be boolean, got '
                . gettype( $settings[self::PARAM_MUST_EXIST] );
        }
 
        if ( !is_bool( $settings[self::PARAM_RETURN_OBJECT] ?? false ) ) {
            $ret['issues'][self::PARAM_RETURN_OBJECT] = 'PARAM_RETURN_OBJECT must be boolean, got '
                . gettype( $settings[self::PARAM_RETURN_OBJECT] );
        }
 
        if ( !empty( $settings[ParamValidator::PARAM_ISMULTI] ) &&
            !empty( $settings[self::PARAM_RETURN_OBJECT] ) &&
            (
                ( $settings[ParamValidator::PARAM_ISMULTI_LIMIT1] ?? 100 ) > 10 ||
                ( $settings[ParamValidator::PARAM_ISMULTI_LIMIT2] ?? 100 ) > 10
            )
        ) {
            $ret['issues'][] = 'Multi-valued title-type parameters with PARAM_RETURN_OBJECT '
                . 'should set low values (<= 10) for PARAM_ISMULTI_LIMIT1 and PARAM_ISMULTI_LIMIT2.'
                . ' (Note that "<= 10" is arbitrary. If something hits this, we can investigate a real limit '
                . 'once we have a real use case to look at.)';
        }
 
        return $ret;
    }
 
    public function getParamInfo( $name, array $settings, array $options ) {
        $info = parent::getParamInfo( $name, $settings, $options );
 
        $info['mustExist'] = !empty( $settings[self::PARAM_MUST_EXIST] );
 
        return $info;
    }
 
    public function getHelpInfo( $name, array $settings, array $options ) {
        $info = parent::getParamInfo( $name, $settings, $options );
 
        $info[ParamValidator::PARAM_TYPE] = MessageValue::new( 'paramvalidator-help-type-title' );
 
        $mustExist = !empty( $settings[self::PARAM_MUST_EXIST] );
        $info[self::PARAM_MUST_EXIST] = $mustExist
            ? MessageValue::new( 'paramvalidator-help-type-title-must-exist' )
            : MessageValue::new( 'paramvalidator-help-type-title-no-must-exist' );
 
        return $info;
    }
 
}