wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Repo\Validators;

use InvalidArgumentException;
use ValueValidators\Error;
use ValueValidators\Result;
use ValueValidators\ValueValidator;

/**
 * The DataFieldValidator class allows the validation of a single field of a complex
 * DataValues object based on the DataValue's array representation.
 *
 * If the respective field is missing or null, the validation will fail with
 * the code 'missing-field'
 *
 * @license GPL-2.0-or-later
 * @author Daniel Kinzler
 */
class DataFieldValidator implements ValueValidator {

    /**
     * @var string|int
     */
    private $field;

    /**
     * @var ValueValidator
     */
    private $validator;

    /**
     * @param string|int $field The field on the target DataValue's array representation to check
     * @param ValueValidator $validator The validator to apply to the given field
     *
     * @throws InvalidArgumentException
     */
    public function __construct( $field, ValueValidator $validator ) {
        if ( !is_string( $field ) && !is_int( $field ) ) {
            throw new InvalidArgumentException( '$field need to be a string or int' );
        }

        $this->field = $field;
        $this->validator = $validator;
    }

    /**
     * @see ValueValidator::validate()
     *
     * @param array $data The data array to validate
     *
     * @return Result
     * @throws InvalidArgumentException
     */
    public function validate( $data ) {
        if ( !is_array( $data ) ) {
            //XXX: or should this just be reported as invalid?
            throw new InvalidArgumentException( 'DataValue is not represented as an array' );
        }

        if ( !isset( $data[$this->field] ) ) {
            return Result::newError( [
                Error::newError(
                    'Required field ' . $this->field . ' not set',
                    $this->field,
                    'missing-field',
                    [ $this->field ]
                ),
            ] );
        }

        $fieldValue = $data[$this->field];

        $result = $this->validator->validate( $fieldValue );

        // TODO: include the field name in the error report
        return $result;
    }

    /**
     * @see ValueValidator::setOptions()
     *
     * @param array $options
     *
     * @codeCoverageIgnore
     */
    public function setOptions( array $options ) {
        // Do nothing. This method shouldn't even be in the interface.
    }

}