MediaWiki  1.30.0
AvroValidator.php
Go to the documentation of this file.
1 <?php
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 );
43  }
44  return [];
45  case AvroSchema::BOOLEAN_TYPE:
46  if ( !is_bool( $datum ) ) {
47  return self::wrongType( 'boolean', $datum );
48  }
49  return [];
50  case AvroSchema::STRING_TYPE:
51  case AvroSchema::BYTES_TYPE:
52  if ( !is_string( $datum ) ) {
53  return self::wrongType( 'string', $datum );
54  }
55  return [];
56  case AvroSchema::INT_TYPE:
57  if ( !is_int( $datum ) ) {
58  return self::wrongType( 'integer', $datum );
59  }
60  if ( AvroSchema::INT_MIN_VALUE > $datum
61  || $datum > AvroSchema::INT_MAX_VALUE
62  ) {
63  return self::outOfRange(
64  AvroSchema::INT_MIN_VALUE,
65  AvroSchema::INT_MAX_VALUE,
66  $datum
67  );
68  }
69  return [];
70  case AvroSchema::LONG_TYPE:
71  if ( !is_int( $datum ) ) {
72  return self::wrongType( 'integer', $datum );
73  }
74  if ( AvroSchema::LONG_MIN_VALUE > $datum
75  || $datum > AvroSchema::LONG_MAX_VALUE
76  ) {
77  return self::outOfRange(
78  AvroSchema::LONG_MIN_VALUE,
79  AvroSchema::LONG_MAX_VALUE,
80  $datum
81  );
82  }
83  return [];
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 );
88  }
89  return [];
90  case AvroSchema::ARRAY_SCHEMA:
91  if ( !is_array( $datum ) ) {
92  return self::wrongType( 'array', $datum );
93  }
94  $errors = [];
95  foreach ( $datum as $d ) {
96  $result = self::getErrors( $schema->items(), $d );
97  if ( $result ) {
98  $errors[] = $result;
99  }
100  }
101  return $errors;
102  case AvroSchema::MAP_SCHEMA:
103  if ( !is_array( $datum ) ) {
104  return self::wrongType( 'array', $datum );
105  }
106  $errors = [];
107  foreach ( $datum as $k => $v ) {
108  if ( !is_string( $k ) ) {
109  $errors[] = self::wrongType( 'string key', $k );
110  }
111  $result = self::getErrors( $schema->values(), $v );
112  if ( $result ) {
113  $errors[$k] = $result;
114  }
115  }
116  return $errors;
117  case AvroSchema::UNION_SCHEMA:
118  $errors = [];
119  foreach ( $schema->schemas() as $schema ) {
120  $result = self::getErrors( $schema, $datum );
121  if ( !$result ) {
122  return [];
123  }
124  $errors[] = $result;
125  }
126  if ( $errors ) {
127  return [ "Expected any one of these to be true", $errors ];
128  }
129  return "No schemas provided to union";
130  case AvroSchema::ENUM_SCHEMA:
131  if ( !in_array( $datum, $schema->symbols() ) ) {
132  $symbols = implode( ', ', $schema->symbols );
133  return "Expected one of $symbols but recieved $datum";
134  }
135  return [];
136  case AvroSchema::FIXED_SCHEMA:
137  if ( !is_string( $datum ) ) {
138  return self::wrongType( 'string', $datum );
139  }
140  $len = strlen( $datum );
141  if ( $len !== $schema->size() ) {
142  return "Expected string of length {$schema->size()}, "
143  . "but recieved one of length $len";
144  }
145  return [];
146  case AvroSchema::RECORD_SCHEMA:
147  case AvroSchema::ERROR_SCHEMA:
148  case AvroSchema::REQUEST_SCHEMA:
149  if ( !is_array( $datum ) ) {
150  return self::wrongType( 'array', $datum );
151  }
152  $errors = [];
153  foreach ( $schema->fields() as $field ) {
154  $name = $field->name();
155  if ( !array_key_exists( $name, $datum ) ) {
156  $errors[$name] = 'Missing expected field';
157  continue;
158  }
159  $result = self::getErrors( $field->type(), $datum[$name] );
160  if ( $result ) {
161  $errors[$name] = $result;
162  }
163  }
164  return $errors;
165  default:
166  return "Unknown avro schema type: {$schema->type}";
167  }
168  }
169 
170  public static function typeOf( $datum ) {
171  return is_object( $datum ) ? get_class( $datum ) : gettype( $datum );
172  }
173 
174  public static function wrongType( $expected, $datum ) {
175  return "Expected $expected, but recieved " . self::typeOf( $datum );
176  }
177 
178  public static function outOfRange( $min, $max, $datum ) {
179  return "Expected value between $min and $max, but recieved $datum";
180  }
181 }
AvroValidator\outOfRange
static outOfRange( $min, $max, $datum)
Definition: AvroValidator.php:178
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1963
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
AvroValidator
Generate error strings for data that doesn't match the specified Avro schema.
Definition: AvroValidator.php:30
AvroValidator\wrongType
static wrongType( $expected, $datum)
Definition: AvroValidator.php:174
AvroValidator\typeOf
static typeOf( $datum)
Definition: AvroValidator.php:170
AvroValidator\getErrors
static getErrors(AvroSchema $schema, $datum)
Definition: AvroValidator.php:38
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9