MediaWiki  REL1_31
SpecialPagesWithProp.php
Go to the documentation of this file.
1 <?php
31 
35  private $propName = null;
36 
40  private $existingPropNames = null;
41 
45  private $reverse = false;
46 
50  private $sortByValue = false;
51 
52  function __construct( $name = 'PagesWithProp' ) {
53  parent::__construct( $name );
54  }
55 
56  function isCacheable() {
57  return false;
58  }
59 
60  public function execute( $par ) {
61  $this->setHeaders();
62  $this->outputHeader();
63  $this->getOutput()->addModuleStyles( 'mediawiki.special.pagesWithProp' );
64 
65  $request = $this->getRequest();
66  $propname = $request->getVal( 'propname', $par );
67  $this->reverse = $request->getBool( 'reverse' );
68  $this->sortByValue = $request->getBool( 'sortbyvalue' );
69 
70  $propnames = $this->getExistingPropNames();
71 
72  $form = HTMLForm::factory( 'ooui', [
73  'propname' => [
74  'type' => 'combobox',
75  'name' => 'propname',
76  'options' => $propnames,
77  'default' => $propname,
78  'label-message' => 'pageswithprop-prop',
79  'required' => true,
80  ],
81  'reverse' => [
82  'type' => 'check',
83  'name' => 'reverse',
84  'default' => $this->reverse,
85  'label-message' => 'pageswithprop-reverse',
86  'required' => false,
87  ],
88  'sortbyvalue' => [
89  'type' => 'check',
90  'name' => 'sortbyvalue',
91  'default' => $this->sortByValue,
92  'label-message' => 'pageswithprop-sortbyvalue',
93  'required' => false,
94  ]
95  ], $this->getContext() );
96  $form->setMethod( 'get' );
97  $form->setSubmitCallback( [ $this, 'onSubmit' ] );
98  $form->setWrapperLegendMsg( 'pageswithprop-legend' );
99  $form->addHeaderText( $this->msg( 'pageswithprop-text' )->parseAsBlock() );
100  $form->setSubmitTextMsg( 'pageswithprop-submit' );
101 
102  $form->prepareForm();
103  $form->displayForm( false );
104  if ( $propname !== '' && $propname !== null ) {
105  $form->trySubmit();
106  }
107  }
108 
109  public function onSubmit( $data, $form ) {
110  $this->propName = $data['propname'];
111  parent::execute( $data['propname'] );
112  }
113 
122  public function prefixSearchSubpages( $search, $limit, $offset ) {
123  $subpages = array_keys( $this->queryExistingProps( $limit, $offset ) );
124  // We've already limited and offsetted, set to N and 0 respectively.
125  return self::prefixSearchArray( $search, count( $subpages ), $subpages, 0 );
126  }
127 
132  function isSyndicated() {
133  return false;
134  }
135 
136  public function getQueryInfo() {
137  return [
138  'tables' => [ 'page_props', 'page' ],
139  'fields' => [
140  'page_id' => 'pp_page',
141  'page_namespace',
142  'page_title',
143  'page_len',
144  'page_is_redirect',
145  'page_latest',
146  'pp_value',
147  ],
148  'conds' => [
149  'pp_propname' => $this->propName,
150  ],
151  'join_conds' => [
152  'page' => [ 'INNER JOIN', 'page_id = pp_page' ]
153  ],
154  'options' => []
155  ];
156  }
157 
158  function getOrderFields() {
159  $sort = [ 'page_id' ];
160  if ( $this->sortByValue ) {
161  array_unshift( $sort, 'pp_sortkey' );
162  }
163  return $sort;
164  }
165 
169  public function sortDescending() {
170  return !$this->reverse;
171  }
172 
178  function formatResult( $skin, $result ) {
180  $ret = $this->getLinkRenderer()->makeKnownLink( $title );
181  if ( $result->pp_value !== '' ) {
182  // Do not show very long or binary values on the special page
183  $valueLength = strlen( $result->pp_value );
184  $isBinary = strpos( $result->pp_value, "\0" ) !== false;
185  $isTooLong = $valueLength > 1024;
186 
187  if ( $isBinary || $isTooLong ) {
188  $message = $this
189  ->msg( $isBinary ? 'pageswithprop-prophidden-binary' : 'pageswithprop-prophidden-long' )
190  ->params( $this->getLanguage()->formatSize( $valueLength ) );
191 
192  $propValue = Html::element( 'span', [ 'class' => 'prop-value-hidden' ], $message->text() );
193  } else {
194  $propValue = Html::element( 'span', [ 'class' => 'prop-value' ], $result->pp_value );
195  }
196 
197  $ret .= $this->msg( 'colon-separator' )->escaped() . $propValue;
198  }
199 
200  return $ret;
201  }
202 
203  public function getExistingPropNames() {
204  if ( $this->existingPropNames === null ) {
205  $this->existingPropNames = $this->queryExistingProps();
206  }
208  }
209 
210  protected function queryExistingProps( $limit = null, $offset = 0 ) {
211  $opts = [
212  'DISTINCT', 'ORDER BY' => 'pp_propname'
213  ];
214  if ( $limit ) {
215  $opts['LIMIT'] = $limit;
216  }
217  if ( $offset ) {
218  $opts['OFFSET'] = $offset;
219  }
220 
221  $res = wfGetDB( DB_REPLICA )->select(
222  'page_props',
223  'pp_propname',
224  '',
225  __METHOD__,
226  $opts
227  );
228 
229  $propnames = [];
230  foreach ( $res as $row ) {
231  $propnames[$row->pp_propname] = $row->pp_propname;
232  }
233 
234  return $propnames;
235  }
236 
237  protected function getGroupName() {
238  return 'pages';
239  }
240 }
SpecialPagesWithProp\onSubmit
onSubmit( $data, $form)
Definition: SpecialPagesWithProp.php:109
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
SpecialPagesWithProp\queryExistingProps
queryExistingProps( $limit=null, $offset=0)
Definition: SpecialPagesWithProp.php:210
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
SpecialPagesWithProp
Special:PagesWithProp to search the page_props table.
Definition: SpecialPagesWithProp.php:30
$ret
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 noclasses & $ret
Definition: hooks.txt:2005
SpecialPagesWithProp\__construct
__construct( $name='PagesWithProp')
Definition: SpecialPagesWithProp.php:52
$res
$res
Definition: database.txt:21
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:752
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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:1993
QueryPage
This is a class for doing query pages; since they're almost all the same, we factor out some of the f...
Definition: QueryPage.php:34
QueryPage\$offset
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:39
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:37
QueryPage\$limit
int $limit
Definition: QueryPage.php:42
SpecialPagesWithProp\execute
execute( $par)
This is the actual workhorse.
Definition: SpecialPagesWithProp.php:60
SpecialPagesWithProp\isSyndicated
isSyndicated()
Disable RSS/Atom feeds.
Definition: SpecialPagesWithProp.php:132
Title\newFromRow
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:464
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
SpecialPagesWithProp\$propName
string null $propName
Definition: SpecialPagesWithProp.php:35
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
SpecialPagesWithProp\$existingPropNames
string[] null $existingPropNames
Definition: SpecialPagesWithProp.php:40
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
SpecialPagesWithProp\$reverse
bool $reverse
Definition: SpecialPagesWithProp.php:45
SpecialPagesWithProp\sortDescending
sortDescending()
Definition: SpecialPagesWithProp.php:169
$sort
$sort
Definition: profileinfo.php:317
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
SpecialPagesWithProp\$sortByValue
bool $sortByValue
Definition: SpecialPagesWithProp.php:50
execute
$batch execute()
SpecialPage\prefixSearchArray
static prefixSearchArray( $search, $limit, array $subpages, $offset)
Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as op...
Definition: SpecialPage.php:518
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialPagesWithProp\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialPagesWithProp.php:122
$skin
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 noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:2011
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
SpecialPagesWithProp\getQueryInfo
getQueryInfo()
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialPagesWithProp.php:136
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:22
SpecialPagesWithProp\formatResult
formatResult( $skin, $result)
Definition: SpecialPagesWithProp.php:178
SpecialPagesWithProp\getExistingPropNames
getExistingPropNames()
Definition: SpecialPagesWithProp.php:203
SpecialPagesWithProp\isCacheable
isCacheable()
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialPagesWithProp.php:56
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
SpecialPagesWithProp\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialPagesWithProp.php:237
SpecialPagesWithProp\getOrderFields
getOrderFields()
Subclasses return an array of fields to order by here.
Definition: SpecialPagesWithProp.php:158
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:629