StringDef.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\ParamValidator\TypeDef;
 
use Wikimedia\ParamValidator\Callbacks;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef;
use Wikimedia\ParamValidator\ValidationException;
 
class StringDef extends TypeDef {
 
    const PARAM_MAX_BYTES = 'param-max-bytes';
 
    const PARAM_MAX_CHARS = 'param-max-chars';
 
    protected $allowEmptyWhenRequired = false;
 
    public function __construct( Callbacks $callbacks, array $options = [] ) {
        parent::__construct( $callbacks );
 
        $this->allowEmptyWhenRequired = !empty( $options['allowEmptyWhenRequired'] );
    }
 
    public function validate( $name, $value, array $settings, array $options ) {
        if ( !$this->allowEmptyWhenRequired && $value === '' &&
            !empty( $settings[ParamValidator::PARAM_REQUIRED] )
        ) {
            throw new ValidationException( $name, $value, $settings, 'missingparam', [] );
        }
 
        if ( isset( $settings[self::PARAM_MAX_BYTES] )
            && strlen( $value ) > $settings[self::PARAM_MAX_BYTES]
        ) {
            throw new ValidationException( $name, $value, $settings, 'maxbytes', [
                'maxbytes' => $settings[self::PARAM_MAX_BYTES] ?? '',
                'maxchars' => $settings[self::PARAM_MAX_CHARS] ?? '',
            ] );
        }
        if ( isset( $settings[self::PARAM_MAX_CHARS] )
            && mb_strlen( $value, 'UTF-8' ) > $settings[self::PARAM_MAX_CHARS]
        ) {
            throw new ValidationException( $name, $value, $settings, 'maxchars', [
                'maxbytes' => $settings[self::PARAM_MAX_BYTES] ?? '',
                'maxchars' => $settings[self::PARAM_MAX_CHARS] ?? '',
            ] );
        }
 
        return $value;
    }
 
}