MediaWiki REL1_28
Go to the documentation of this file.
27abstract class ApiQueryTestBase extends ApiTestCase {
29 const PARAM_ASSERT = <<<STR
30Each parameter must be an array of two elements,
31first - an array of params to the API call,
32and the second array - expected results as returned by the API
40 protected function merge( /*...*/ ) {
41 $request = [];
42 $expected = [];
43 foreach ( func_get_args() as $v ) {
44 list( $req, $exp ) = $this->validateRequestExpectedPair( $v );
45 $request = array_merge_recursive( $request, $req );
46 $this->mergeExpected( $expected, $exp );
47 }
49 return [ $request, $expected ];
50 }
58 private function validateRequestExpectedPair( $v ) {
59 $this->assertInternalType( 'array', $v, self::PARAM_ASSERT );
60 $this->assertEquals( 2, count( $v ), self::PARAM_ASSERT );
61 $this->assertArrayHasKey( 0, $v, self::PARAM_ASSERT );
62 $this->assertArrayHasKey( 1, $v, self::PARAM_ASSERT );
63 $this->assertInternalType( 'array', $v[0], self::PARAM_ASSERT );
64 $this->assertInternalType( 'array', $v[1], self::PARAM_ASSERT );
66 return $v;
67 }
74 private function mergeExpected( &$all, $item ) {
75 foreach ( $item as $k => $v ) {
76 if ( array_key_exists( $k, $all ) ) {
77 if ( is_array( $all[$k] ) ) {
78 $this->mergeExpected( $all[$k], $v );
79 } else {
80 $this->assertEquals( $all[$k], $v );
81 }
82 } else {
83 $all[$k] = $v;
84 }
85 }
86 }
96 protected function check( $values, array $session = null,
97 $appendModule = false, User $user = null
98 ) {
99 list( $req, $exp ) = $this->validateRequestExpectedPair( $values );
100 if ( !array_key_exists( 'action', $req ) ) {
101 $req['action'] = 'query';
102 }
103 foreach ( $req as &$val ) {
104 if ( is_array( $val ) ) {
105 $val = implode( '|', array_unique( $val ) );
106 }
107 }
108 $result = $this->doApiRequest( $req, $session, $appendModule, $user );
109 $this->assertResult( [ 'batchcomplete' => true, 'query' => $exp ], $result[0], $req );
110 }
112 protected function assertResult( $exp, $result, $message = '' ) {
113 try {
114 $exp = self::sanitizeResultArray( $exp );
116 $this->assertEquals( $exp, $result );
117 } catch ( PHPUnit_Framework_ExpectationFailedException $e ) {
118 if ( is_array( $message ) ) {
119 $message = http_build_query( $message );
120 }
122 // FIXME: once we migrate to phpunit 4.1+, hardcode ComparisonFailure exception use
123 $compEx = 'SebastianBergmann\Comparator\ComparisonFailure';
124 if ( !class_exists( $compEx ) ) {
125 $compEx = 'PHPUnit_Framework_ComparisonFailure';
126 }
128 throw new PHPUnit_Framework_ExpectationFailedException(
129 $e->getMessage() . "\nRequest: $message",
130 new $compEx(
131 $exp,
132 $result,
133 print_r( $exp, true ),
134 print_r( $result, true ),
135 false,
136 $e->getComparisonFailure()->getMessage() . "\nRequest: $message"
137 )
138 );
139 }
140 }
147 private static function sanitizeResultArray( $result ) {
148 unset( $result['pageid'] );
149 foreach ( $result as $key => $value ) {
150 if ( is_array( $value ) ) {
152 }
153 }
155 // Sort the result by keys, then take advantage of how array_merge will
156 // renumber numeric keys while leaving others alone.
157 ksort( $result );
158 return array_merge( $result );
159 }
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
This class has some common functionality for testing query module.
mergeExpected(&$all, $item)
Recursively merges the expected values in the $item into the $all.
check( $values, array $session=null, $appendModule=false, User $user=null)
Checks that the request's result matches the expected results.
assertResult( $exp, $result, $message='')
Merges all requests parameter + expected values into one.
validateRequestExpectedPair( $v)
Check that the parameter is a valid two element array, with the first element being API request and t...
static sanitizeResultArray( $result)
Recursively ksorts a result array and removes any 'pageid' keys.
doApiRequest(array $params, array $session=null, $appendModule=false, User $user=null)
Does the API request and returns the result.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
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
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition globals.txt:10
this hook is for auditing only $req
Definition hooks.txt:1010
the array() calling protocol came about after MediaWiki 1.4rc1.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:249
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:Associative array mapping language codes to prefixed links of the form "language:title". & $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:1937
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2685
returning false will NOT prevent logging $e
Definition hooks.txt:2110
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:37