138 # NB: the offset is quoted, not validated. It is treated as an
139 # arbitrary string to support the widest variety of index types. Be
140 # careful outputting it into HTML!
141 $this->mOffset = $this->mRequest->getText(
'offset' );
143 # Use consistent behavior for the limit options
144 $this->mDefaultLimit = $this->
getUser()->getIntOption(
'rclimit' );
145 if ( !$this->mLimit ) {
147 list( $this->mLimit, ) = $this->mRequest->getLimitOffset();
150 $this->mIsBackwards = ( $this->mRequest->getVal(
'dir' ) ==
'prev' );
151 # Let the subclass set the DB here; otherwise use a replica DB for the current wiki
156 $order = $this->mRequest->getVal(
'order' );
157 if ( is_array( $index ) && isset( $index[$order] ) ) {
158 $this->mOrderType = $order;
159 $this->mIndexField = $index[$order];
160 $this->mExtraSortFields = isset( $extraSort[$order] )
161 ? (
array)$extraSort[$order]
163 } elseif ( is_array( $index ) ) {
164 # First element is the default
166 list( $this->mOrderType, $this->mIndexField ) = each( $index );
167 $this->mExtraSortFields = isset( $extraSort[$this->mOrderType] )
168 ? (
array)$extraSort[$this->mOrderType]
171 # $index is not an array
172 $this->mOrderType =
null;
173 $this->mIndexField = $index;
174 $this->mExtraSortFields = (
array)$extraSort;
177 if ( !isset( $this->mDefaultDirection ) ) {
179 $this->mDefaultDirection = is_array( $dir )
200 # Use the child class name for profiling
201 $fname = __METHOD__ .
' (' . static::class .
')';
206 # Plus an extra row so that we can tell the "next" link should be shown
207 $queryLimit = $this->mLimit + 1;
209 if ( $this->mOffset ==
'' ) {
217 $isFirst = !$this->
reallyDoQuery( $this->mOffset, 1, !$descending )->numRows();
218 $this->mIncludeOffset = $oldIncludeOffset;
228 $this->mQueryDone =
true;
231 $this->mResult->rewind();
247 $this->mOffset = $offset;
258 $limit = (int)$limit;
260 if ( $limit > 5000 ) {
264 $this->mLimit = $limit;
285 $this->mIncludeOffset = $include;
298 $numRows =
$res->numRows();
300 # Remove any table prefix from index field
301 $parts = explode(
'.', $this->mIndexField );
302 $indexColumn = end( $parts );
304 $row =
$res->fetchRow();
305 $firstIndex = $row[$indexColumn];
307 # Discard the extra result row if there is one
308 if ( $numRows > $this->mLimit && $numRows > 1 ) {
309 $res->seek( $numRows - 1 );
310 $this->mPastTheEndRow =
$res->fetchObject();
311 $this->mPastTheEndIndex = $this->mPastTheEndRow->$indexColumn;
312 $res->seek( $numRows - 2 );
313 $row =
$res->fetchRow();
314 $lastIndex = $row[$indexColumn];
316 $this->mPastTheEndRow =
null;
317 # Setting indexes to an empty string means that they will be
318 # omitted if they would otherwise appear in URLs. It just so
319 # happens that this is the right thing to do in the standard
320 # UI, in all the relevant cases.
321 $this->mPastTheEndIndex =
'';
322 $res->seek( $numRows - 1 );
323 $row =
$res->fetchRow();
324 $lastIndex = $row[$indexColumn];
329 $this->mPastTheEndRow =
null;
330 $this->mPastTheEndIndex =
'';
333 if ( $this->mIsBackwards ) {
334 $this->mIsFirst = ( $numRows < $limit );
335 $this->mIsLast = $isFirst;
336 $this->mLastShown = $firstIndex;
337 $this->mFirstShown = $lastIndex;
339 $this->mIsFirst = $isFirst;
340 $this->mIsLast = ( $numRows < $limit );
341 $this->mLastShown = $lastIndex;
342 $this->mFirstShown = $firstIndex;
352 return static::class;
383 $fields = $info[
'fields'];
384 $conds = isset( $info[
'conds'] ) ? $info[
'conds'] : [];
385 $options = isset( $info[
'options'] ) ? $info[
'options'] : [];
386 $join_conds = isset( $info[
'join_conds'] ) ? $info[
'join_conds'] : [];
387 $sortColumns = array_merge( [ $this->mIndexField ], $this->mExtraSortFields );
389 $options[
'ORDER BY'] = $sortColumns;
390 $operator = $this->mIncludeOffset ?
'>=' :
'>';
393 foreach ( $sortColumns
as $col ) {
394 $orderBy[] = $col .
' DESC';
397 $operator = $this->mIncludeOffset ?
'<=' :
'<';
399 if ( $offset !=
'' ) {
400 $conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
402 $options[
'LIMIT'] = intval( $limit );
421 if ( !$this->mQueryDone ) {
425 if ( $this->mResult->numRows() ) {
426 # Do any special query batches before display
430 # Don't use any extra rows returned by the query
431 $numRows = min( $this->mResult->numRows(), $this->mLimit );
435 if ( $this->mIsBackwards ) {
436 for ( $i = $numRows - 1; $i >= 0; $i-- ) {
437 $this->mResult->seek( $i );
438 $row = $this->mResult->fetchObject();
442 $this->mResult->seek( 0 );
443 for ( $i = 0; $i < $numRows; $i++ ) {
444 $row = $this->mResult->fetchObject();
470 if ( in_array(
$type, [
'prev',
'next' ] ) ) {
471 $attrs[
'rel'] =
$type;
474 if ( in_array(
$type, [
'asc',
'desc' ] ) ) {
475 $attrs[
'title'] =
wfMessage(
$type ==
'asc' ?
'sort-ascending' :
'sort-descending' )->
text();
479 $attrs[
'class'] =
"mw-{$type}link";
537 if ( !isset( $this->mDefaultQuery ) ) {
538 $this->mDefaultQuery = $this->
getRequest()->getQueryValues();
539 unset( $this->mDefaultQuery[
'title'] );
540 unset( $this->mDefaultQuery[
'dir'] );
541 unset( $this->mDefaultQuery[
'offset'] );
542 unset( $this->mDefaultQuery[
'limit'] );
543 unset( $this->mDefaultQuery[
'order'] );
544 unset( $this->mDefaultQuery[
'month'] );
545 unset( $this->mDefaultQuery[
'year'] );
556 if ( !$this->mQueryDone ) {
559 return $this->mResult->numRows();
568 if ( !$this->mQueryDone ) {
572 # Don't announce the limit everywhere if it's the default
573 $urlLimit = $this->mLimit == $this->mDefaultLimit ? null :
$this->mLimit;
575 if ( $this->mIsFirst ) {
584 $first = [
'limit' => $urlLimit ];
586 if ( $this->mIsLast ) {
591 $last = [
'dir' =>
'prev',
'limit' => $urlLimit ];
607 if ( !$this->mQueryDone ) {
635 } elseif ( isset( $disabledTexts[
$type] ) ) {
647 if ( $this->mIsBackwards ) {
652 foreach ( $this->mLimitsShown
as $limit ) {
655 [
'offset' => $offset,
'limit' => $limit ],
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
getTitle()
Get the Title object.
getLanguage()
Get the Language object.
setContext(IContextSource $context)
Set the IContextSource object.
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
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
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
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
the array() calling protocol came about after MediaWiki 1.4rc1.
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
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
Interface for objects which can provide a MediaWiki context on request.