You are here

class PHPUnit_Framework_Constraint_JsonMatches_ErrorMessageProvider in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/phpunit/phpunit/src/Framework/Constraint/JsonMatches/ErrorMessageProvider.php \PHPUnit_Framework_Constraint_JsonMatches_ErrorMessageProvider

Provides human readable messages for each JSON error.

@since Class available since Release 3.7.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_JsonMatches_ErrorMessageProvider

File

vendor/phpunit/phpunit/src/Framework/Constraint/JsonMatches/ErrorMessageProvider.php, line 16

View source
class PHPUnit_Framework_Constraint_JsonMatches_ErrorMessageProvider {

  /**
   * Translates JSON error to a human readable string.
   *
   * @param  string $error
   * @param  string $prefix
   * @return string
   */
  public static function determineJsonError($error, $prefix = '') {
    switch ($error) {
      case JSON_ERROR_NONE:
        return;
      case JSON_ERROR_DEPTH:
        return $prefix . 'Maximum stack depth exceeded';
      case JSON_ERROR_STATE_MISMATCH:
        return $prefix . 'Underflow or the modes mismatch';
      case JSON_ERROR_CTRL_CHAR:
        return $prefix . 'Unexpected control character found';
      case JSON_ERROR_SYNTAX:
        return $prefix . 'Syntax error, malformed JSON';
      case JSON_ERROR_UTF8:
        return $prefix . 'Malformed UTF-8 characters, possibly incorrectly encoded';
      default:
        return $prefix . 'Unknown error';
    }
  }

  /**
   * Translates a given type to a human readable message prefix.
   *
   * @param  string $type
   * @return string
   */
  public static function translateTypeToPrefix($type) {
    switch (strtolower($type)) {
      case 'expected':
        $prefix = 'Expected value JSON decode error - ';
        break;
      case 'actual':
        $prefix = 'Actual value JSON decode error - ';
        break;
      default:
        $prefix = '';
        break;
    }
    return $prefix;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Framework_Constraint_JsonMatches_ErrorMessageProvider::determineJsonError public static function Translates JSON error to a human readable string.
PHPUnit_Framework_Constraint_JsonMatches_ErrorMessageProvider::translateTypeToPrefix public static function Translates a given type to a human readable message prefix.