MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
3 namespace Wikimedia\Rdbms;
5 use stdClass;
6 use RuntimeException;
24 class ResultWrapper implements IResultWrapper {
26  public $result;
29  protected $db;
32  protected $pos = 0;
34  protected $currentRow = null;
45  public function __construct( IDatabase $db = null, $result ) {
46  $this->db = $db;
47  if ( $result instanceof ResultWrapper ) {
48  $this->result = $result->result;
49  } else {
50  $this->result = $result;
51  }
52  }
54  public function numRows() {
55  return $this->getDB()->numRows( $this );
56  }
58  public function fetchObject() {
59  return $this->getDB()->fetchObject( $this );
60  }
62  public function fetchRow() {
63  return $this->getDB()->fetchRow( $this );
64  }
66  public function seek( $row ) {
67  $this->getDB()->dataSeek( $this, $row );
68  }
70  public function free() {
71  if ( $this->db ) {
72  $this->db->freeResult( $this );
73  $this->db = null;
74  }
75  $this->result = null;
76  }
82  private function getDB() {
83  if ( !$this->db ) {
84  throw new RuntimeException( static::class . ' needs a DB handle for iteration.' );
85  }
87  return $this->db;
88  }
90  function rewind() {
91  if ( $this->numRows() ) {
92  $this->getDB()->dataSeek( $this, 0 );
93  }
94  $this->pos = 0;
95  $this->currentRow = null;
96  }
98  function current() {
99  if ( is_null( $this->currentRow ) ) {
100  $this->next();
101  }
103  return $this->currentRow;
104  }
106  function key() {
107  return $this->pos;
108  }
110  function next() {
111  $this->pos++;
112  $this->currentRow = $this->fetchObject();
114  return $this->currentRow;
115  }
117  function valid() {
118  return $this->current() !== false;
119  }
120 }
122 class_alias( ResultWrapper::class, 'ResultWrapper' );
Definition: ResultWrapper.php:106
Fetch the next row from the given result object, in associative array form.
Definition: ResultWrapper.php:62
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:1954
Definition: ResultWrapper.php:110
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Definition: ChronologyProtector.php:24
stdClass null $currentRow
Definition: ResultWrapper.php:34
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
Definition: ResultWrapper.php:82
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
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
Definition: ResultWrapper.php:117
resource array null $result
Optional underlying result handle for subclass usage.
Definition: ResultWrapper.php:26
seek( $row)
Change the position of the cursor in a result object.
Definition: ResultWrapper.php:66
Result wrapper for grabbing data queried from an IDatabase object.
Definition: IResultWrapper.php:24
Free a result object.
Definition: ResultWrapper.php:70
IDatabase null $db
Definition: ResultWrapper.php:29
Fetch the next row from the given result object, in object form.
Definition: ResultWrapper.php:58
int $pos
Definition: ResultWrapper.php:32
__construct(IDatabase $db=null, $result)
Create a row iterator from a result resource and an optional Database object.
Definition: ResultWrapper.php:45
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Definition: ResultWrapper.php:90
Definition: ResultWrapper.php:98
Get the number of rows in a result object.
Definition: ResultWrapper.php:54
the array() calling protocol came about after MediaWiki 1.4rc1.