Commit graph

28 commits

Author SHA1 Message Date
Thiemo Mättig
23632a4ecd Use precise ApiMain/ApiQuery type hints in all API modules
Which type is used depends on the ApiModuleManager responsible for
the API module. There are two managers, one in ApiMain and one in
ApiQuery. Both contain a list of API modules they instantiate.
Both use $this as the first parameter in the constructors of the
individual modules. There is no other regular way to instantiate the
modules, so we know the type must either be ApiMain or ApiQuery.

The lists don't intersect.

I would have prefered the naming scheme $mainModule for ApiMain
modules and $queryModule for ApiQuery modules but since this
doesn't add much I left the shorter variable names untouched.

Change-Id: Ie6bf19150f1c9b619655a06a8e051412665e54db
2014-05-16 11:07:23 -04:00
umherirrender
e63299d208 Fixed some @params documentation (includes/api)
Swapped some "$var type" to "type $var" or added missing types
before the $var. Changed some other types to match the more common
spelling. Makes beginning of some text in captial.
Also added some missing @param.

Change-Id: I758fa4ad80ac95e2ddd3770bcb9b7d2e57ec34ea
2014-04-18 13:55:36 +00:00
addshore
719d7a2f03 Add final period to API module descriptions
Change-Id: Icae68c1ab1fd0006e00a3a9a56ae8f831d3d0d45
2014-03-10 09:04:08 +00:00
Siebrand Mazeland
770f2a2d41 Fix CodeSniffer errors and warnings (you guessed it, on API classes)
Change-Id: I56f9632975d53bdfe33ff9412e1a4ba010bdb2aa
2013-11-15 18:08:13 +00:00
Siebrand Mazeland
789c20044b Update formatting, return of the API classes
Change-Id: I8c3a5b4396a1c3bba22f676137f640c6aa3c8960
2013-11-14 18:25:45 +00:00
Brad Jorsch
0ae0c665f5 (bug 43251) API prop=pageprops ppprop should accept multiple values
There is no reason for this parameter not to accept multiple values, the
query is structurally exactly the same as for something like
prop=categories&clcategories=....

Unless, of course, we need to support page props with "|" in the name.

Change-Id: I38cd83e213ede8e626d55c079c5c1b6f7e727336
2013-02-20 08:42:53 -05:00
umherirrender
f97a3a4027 fix some spacing
Change-Id: I670a7baf3ba1e70d18346bb00938d518ba2063bd
2013-02-04 19:59:14 +00:00
Yuri Astrakhan
503cd2f4ae (bug 35885) remove api version string and parameter
API was using SVN's version keyword which GIT does not support.
All related methods were either removed, or for those that
could have been used from extensions, emptied out.
api.php?version now shows unrecognized param warning.

Change-Id: I910ca1448ed2ed697ac19b17c486d130aa1d7e03
2013-01-18 12:41:18 -05:00
Sam Reed
53000baecf Oh noes, moar http:// -> https:// 2011-11-28 15:43:11 +00:00
John Du Hart
2e7d867478 Removed the 'eclipse helper' bit on top of every API module
It's a parctice that dates back to 2006 when the API was first written, and frankly isn't covered by the coding conventions. Same thing with the docblocks, they're all copypasted with some bits changed and don't even make sense if you look at them in the genereated code docs.
I don't feel that any of us depend on this anymore (get a better IDE), so in the inerest of consistancy it's time we said goodbye to it.
2011-11-16 00:17:26 +00:00
Sam Reed
a5628f5734 Based on diff to wikia, set more functions consistently public rather than protected 2011-08-17 22:24:21 +00:00
Sam Reed
d5e46f9614 Followup r92396
More modules documented, pretty much only action=query&list= to be done (ie links added where documentation pages exist already)
2011-07-17 16:51:11 +00:00
Sam Reed
5db6b7ab5c * (bug 27479) API error when using both prop=pageprops and prop=info&inprop=displaytitle
Followup r75282

Patch by Brad Jorsch
2011-02-16 23:38:21 +00:00
Sam Reed
27c07317c4 * (bug 26480) add a pppageprops param to prop=pageprops 2011-01-05 22:11:39 +00:00
Sam Reed
c5c5092156 Minor code order tweaks in ApiQueryPageProps.
Remove getPossibleErrors, as it adds an error that this module doesn't through
2011-01-05 21:59:05 +00:00
Sam Reed
1f05665cf3 Styleli[zs]e the API up to date (Been a while since) 2010-12-30 17:06:09 +00:00
Bryan Tong Minh
2259ecd6d7 Follow-up to r75282: don't query if there are no pages to query 2010-12-29 20:32:14 +00:00
Sam Reed
6309c920dd Delete all the "API for MediaWiki 1.8+" comments
Add since to ApiQueryQueryPage
2010-12-22 20:52:06 +00:00
Bryan Tong Minh
9af2264645 Follow-up r75282
* Use addWhere instead of addWhereFld
* Don't add properties twice if there is a continue
* Add comments
2010-10-26 19:31:47 +00:00
Sam Reed
d194b9a179 Followup r75282, remove now unused class variables 2010-10-26 16:37:15 +00:00
Bryan Tong Minh
fae7025644 Follow-up r70638:
* Use a single query to get the page_props instead of one per page
* Removed the $wgPageProps global
* Removed a lot of useless crap
2010-10-23 18:53:39 +00:00
Sam Reed
550271e806 Explicit class variable definition
Parameter hints
2010-10-06 21:18:55 +00:00
Sam Reed
48a042cbf6 Remove some unneeded whitespace 2010-08-23 22:18:05 +00:00
X!
c9f278aa4a Fix r70770: Will I ever get this working? :) 2010-08-09 21:03:13 +00:00
X!
f40723965b Followup to r70701: Facepalm fixing. 2010-08-09 16:26:35 +00:00
X!
b528bcdf89 Followup to r70638: Clean up code, add prop to function args, add comment 2010-08-08 14:55:08 +00:00
Alexandre Emsenhuber
457eb73b61 Standardised file description headers, added @file 2010-08-07 19:59:42 +00:00
X!
685ef510ee -(bug 24484) Add prop=pageprops module
-Add $wgPageProps global variable
2010-08-07 18:50:23 +00:00