TypeDef.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\ParamValidator;
 
abstract class TypeDef {
 
    protected $callbacks;
 
    public function __construct( Callbacks $callbacks ) {
        $this->callbacks = $callbacks;
    }
 
    public function getValue( $name, array $settings, array $options ) {
        return $this->callbacks->getValue( $name, null, $options );
    }
 
    abstract public function validate( $name, $value, array $settings, array $options );
 
    public function normalizeSettings( array $settings ) {
        return $settings;
    }
 
    public function getEnumValues( $name, array $settings, array $options ) {
        return null;
    }
 
    public function stringifyValue( $name, $value, array $settings, array $options ) {
        return (string)$value;
    }
 
    public function describeSettings( $name, array $settings, array $options ) {
        $compact = !empty( $options['compact'] );
 
        $ret = [];
 
        if ( isset( $settings[ParamValidator::PARAM_DEFAULT] ) ) {
            $value = $this->stringifyValue(
                $name, $settings[ParamValidator::PARAM_DEFAULT], $settings, $options
            );
            $ret['default'] = $compact ? [ 'value' => $value ] : $value;
        }
 
        return $ret;
    }
 
}