3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
22 * Generate error strings for data that doesn't match the specified
23 * Avro schema. This is very similar to AvroSchema::is_valid_datum(),
24 * but returns error messages instead of a boolean.
27 * @author Erik Bernhardson <ebernhardson@wikimedia.org>
28 * @copyright © 2015 Erik Bernhardson and Wikimedia Foundation.
32 * @param AvroSchema $schema The rules to conform to.
33 * @param mixed $datum The value to validate against $schema.
34 * @return string|string[] An error or list of errors in the
35 * provided $datum. When no errors exist the empty array is
38 public static function getErrors( AvroSchema
$schema, $datum ) {
39 switch ( $schema->type
) {
40 case AvroSchema
::NULL_TYPE
:
41 if ( !is_null($datum) ) {
42 return self
::wrongType( 'null', $datum );
45 case AvroSchema
::BOOLEAN_TYPE
:
46 if ( !is_bool($datum) ) {
47 return self
::wrongType( 'boolean', $datum );
50 case AvroSchema
::STRING_TYPE
:
51 case AvroSchema
::BYTES_TYPE
:
52 if ( !is_string($datum) ) {
53 return self
::wrongType( 'string', $datum );
56 case AvroSchema
::INT_TYPE
:
57 if ( !is_int($datum) ) {
58 return self
::wrongType( 'integer', $datum );
60 if ( AvroSchema
::INT_MIN_VALUE
> $datum
61 ||
$datum > AvroSchema
::INT_MAX_VALUE
63 return self
::outOfRange(
64 AvroSchema
::INT_MIN_VALUE
,
65 AvroSchema
::INT_MAX_VALUE
,
70 case AvroSchema
::LONG_TYPE
:
71 if ( !is_int($datum) ) {
72 return self
::wrongType( 'integer', $datum );
74 if ( AvroSchema
::LONG_MIN_VALUE
> $datum
75 ||
$datum > AvroSchema
::LONG_MAX_VALUE
77 return self
::outOfRange(
78 AvroSchema
::LONG_MIN_VALUE
,
79 AvroSchema
::LONG_MAX_VALUE
,
84 case AvroSchema
::FLOAT_TYPE
:
85 case AvroSchema
::DOUBLE_TYPE
:
86 if ( !is_float($datum) && !is_int($datum) ) {
87 return self
::wrongType( 'float or integer', $datum );
90 case AvroSchema
::ARRAY_SCHEMA
:
91 if (!is_array($datum)) {
92 return self
::wrongType( 'array', $datum );
95 foreach ($datum as $d) {
96 $result = $this->validate( $schema->items(), $d );
105 case AvroSchema
::MAP_SCHEMA
:
106 if (!is_array($datum)) {
107 return self
::wrongType( 'array', $datum );
110 foreach ($datum as $k => $v) {
111 if ( !is_string($k) ) {
112 $errors[] = self
::wrongType( 'string key', $k );
114 $result = self
::getErrors( $schema->values(), $v );
116 $errors[$k] = $result;
120 case AvroSchema
::UNION_SCHEMA
:
122 foreach ($schema->schemas() as $schema) {
123 $result = self
::getErrors( $schema, $datum );
130 return array( "Expected any one of these to be true", $errors );
132 return "No schemas provided to union";
133 case AvroSchema
::ENUM_SCHEMA
:
134 if ( !in_array( $datum, $schema->symbols() ) ) {
135 $symbols = implode( ', ', $schema->symbols
);
136 return "Expected one of $symbols but recieved $datum";
139 case AvroSchema
::FIXED_SCHEMA
:
140 if ( !is_string( $datum ) ) {
141 return self
::wrongType( 'string', $datum );
143 $len = strlen( $datum );
144 if ( $len !== $schema->size() ) {
145 return "Expected string of length {$schema->size()}, "
146 . "but recieved one of length $len";
149 case AvroSchema
::RECORD_SCHEMA
:
150 case AvroSchema
::ERROR_SCHEMA
:
151 case AvroSchema
::REQUEST_SCHEMA
:
152 if ( !is_array( $datum ) ) {
153 return self
::wrongType( 'array', $datum );
156 foreach ( $schema->fields() as $field ) {
157 $name = $field->name();
158 if ( !array_key_exists( $name, $datum ) ) {
159 $errors[$name] = 'Missing expected field';
162 $result = self
::getErrors( $field->type(), $datum[$name] );
164 $errors[$name] = $result;
169 return "Unknown avro schema type: {$schema->type}";
173 public static function typeOf( $datum ) {
174 return is_object( $datum ) ?
get_class( $datum ) : gettype( $datum );
177 public static function wrongType( $expected, $datum ) {
178 return "Expected $expected, but recieved " . self
::typeOf( $datum );
181 public static function outOfRange( $min, $max, $datum ) {
182 return "Expected value between $min and $max, but recieved $datum";