Validator.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2020 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\validation;
 
use wcmf\lib\config\ConfigurationException;
use wcmf\lib\core\ObjectFactory;
 
/**
 * Validator is is the single entry point for validation.
 * It chooses the configured validateType based on the validateTypeDesc parameter
 * from the configuration section 'validators'.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class Validator {
 
  /**
   * Validate the given value against the given validateType description.
   * @param $value The value to validate
   * @param $validateDesc A string in the form validateTypeA,validateTypeB:optionsB, where
   *     validateType is a key in the configuration section 'validators' and
   *     options is a JSON encoded object as used in the 'validate_type' definition
   * @param $context An associative array describing the validation context which will be passed
   *     to the ValidateType::validate() method (optional)
   * @return Boolean
   */
  public static function validate($value, $validateDesc, $context=null) {
 
    // get validator list
    $validators = [];
 
    // split validateTypeDesc by commas and colons (separates validateType from options)
    $validateDescParts = [];
    preg_match_all('/\{(?:[^{}]|(?R))+\}|[^{}:,\s]+/', $validateDesc, $validateDescParts);
    // combine validateType and options again
    foreach ($validateDescParts[0] as $validateDescPart) {
      if (preg_match('/^\{.*?\}$/', $validateDescPart)) {
        // options of preceding validator
        $numValidators = sizeof($validators);
        if ($numValidators > 0) {
          $validators[$numValidators-1] .= ':'.$validateDescPart;
        }
      }
      else {
        $validators[] = $validateDescPart;
      }
    }
 
    // validate against each validator
    foreach ($validators as $validator) {
      list($validateTypeName, $validateOptions) = array_pad(preg_split('/:/', $validator, 2), 2, null);
 
      // get the validator that should be used for this value
      $validatorInstance = self::getValidateType($validateTypeName);
      if ($validateOptions !== null) {
        $decodedOptions = json_decode($validateOptions, true);
        if ($decodedOptions === null) {
          throw new ConfigurationException("No valid JSON format: ".$validateOptions);
        }
        $validateOptions = $decodedOptions;
      }
      if (!$validatorInstance->validate($value, $validateOptions, $context)) {
        return false;
      }
    }
 
    // all validators passed
    return true;
  }
 
  /**
   * Get the ValidateType instance for the given name.
   * @param $validateTypeName The validate type's name
   * @return ValidateType instance
   */
  protected static function getValidateType($validateTypeName) {
    $validatorTypes = ObjectFactory::getInstance('validators');
    if (!isset($validatorTypes[$validateTypeName])) {
      throw new ConfigurationException("Configuration section 'Validators' does not contain a validator named: ".$validateTypeName);
    }
    return $validatorTypes[$validateTypeName];
  }
}
?>