X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryDeletedrevs.php;h=f828255bf176bfce2cfa5ea14a2ca3aff7ac884b;hb=68aab7ca8bd2bf7271a2f69aff1e7a60ab88078b;hp=6b1185b882c7675ce31015d5c4a2ec122bf4e47e;hpb=0525f22b8825c617fffa98f191ab07e8113da085;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiQueryDeletedrevs.php b/includes/api/ApiQueryDeletedrevs.php
index 6b1185b882..f828255bf1 100644
--- a/includes/api/ApiQueryDeletedrevs.php
+++ b/includes/api/ApiQueryDeletedrevs.php
@@ -28,6 +28,7 @@
  * Query module to enumerate all deleted revisions.
  *
  * @ingroup API
+ * @deprecated since 1.25
  */
 class ApiQueryDeletedrevs extends ApiQueryBase {
 
@@ -45,6 +46,12 @@ class ApiQueryDeletedrevs extends ApiQueryBase {
 			);
 		}
 
+		$this->setWarning(
+			'list=deletedrevs has been deprecated. Please use prop=deletedrevisions or ' .
+			'list=alldeletedrevisions instead.'
+		);
+		$this->logFeatureUsage( 'action=query&list=deletedrevs' );
+
 		$db = $this->getDB();
 		$params = $this->extractRequestParams( false );
 		$prop = array_flip( $params['prop'] );
@@ -61,6 +68,13 @@ class ApiQueryDeletedrevs extends ApiQueryBase {
 		$fld_token = isset( $prop['token'] );
 		$fld_tags = isset( $prop['tags'] );
 
+		if ( isset( $prop['token'] ) ) {
+			$p = $this->getModulePrefix();
+			$this->setWarning(
+				"{$p}prop=token has been deprecated. Please use action=query&meta=tokens instead."
+			);
+		}
+
 		// If we're in JSON callback mode, no tokens can be obtained
 		if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
 			$fld_token = false;
@@ -413,43 +427,53 @@ class ApiQueryDeletedrevs extends ApiQueryBase {
 		$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
 	}
 
+	public function isDeprecated() {
+		return true;
+	}
+
 	public function getAllowedParams() {
 		return array(
 			'start' => array(
-				ApiBase::PARAM_TYPE => 'timestamp'
+				ApiBase::PARAM_TYPE => 'timestamp',
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 1, 2 ) ),
 			),
 			'end' => array(
 				ApiBase::PARAM_TYPE => 'timestamp',
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 1, 2 ) ),
 			),
 			'dir' => array(
 				ApiBase::PARAM_TYPE => array(
 					'newer',
 					'older'
 				),
-				ApiBase::PARAM_DFLT => 'older'
+				ApiBase::PARAM_DFLT => 'older',
+				ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 1, 3 ) ),
 			),
-			'from' => null,
-			'to' => null,
-			'prefix' => null,
-			'continue' => null,
-			'unique' => false,
-			'tag' => null,
-			'user' => array(
-				ApiBase::PARAM_TYPE => 'user'
+			'from' => array(
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
 			),
-			'excludeuser' => array(
-				ApiBase::PARAM_TYPE => 'user'
+			'to' => array(
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
+			),
+			'prefix' => array(
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
+			),
+			'unique' => array(
+				ApiBase::PARAM_DFLT => false,
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
 			),
 			'namespace' => array(
 				ApiBase::PARAM_TYPE => 'namespace',
 				ApiBase::PARAM_DFLT => NS_MAIN,
+				ApiBase::PARAM_HELP_MSG_INFO => array( array( 'modes', 3 ) ),
 			),
-			'limit' => array(
-				ApiBase::PARAM_DFLT => 10,
-				ApiBase::PARAM_TYPE => 'limit',
-				ApiBase::PARAM_MIN => 1,
-				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
-				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+			'tag' => null,
+			'user' => array(
+				ApiBase::PARAM_TYPE => 'user'
+			),
+			'excludeuser' => array(
+				ApiBase::PARAM_TYPE => 'user'
 			),
 			'prop' => array(
 				ApiBase::PARAM_DFLT => 'user|comment',
@@ -469,68 +493,30 @@ class ApiQueryDeletedrevs extends ApiQueryBase {
 				),
 				ApiBase::PARAM_ISMULTI => true
 			),
-		);
-	}
-
-	public function getParamDescription() {
-		return array(
-			'start' => 'The timestamp to start enumerating from (1, 2)',
-			'end' => 'The timestamp to stop enumerating at (1, 2)',
-			'dir' => $this->getDirectionDescription( $this->getModulePrefix(), ' (1, 3)' ),
-			'from' => 'Start listing at this title (3)',
-			'to' => 'Stop listing at this title (3)',
-			'prefix' => 'Search for all page titles that begin with this value (3)',
-			'limit' => 'The maximum amount of revisions to list',
-			'prop' => array(
-				'Which properties to get',
-				' revid          - Adds the revision ID of the deleted revision',
-				' parentid       - Adds the revision ID of the previous revision to the page',
-				' user           - Adds the user who made the revision',
-				' userid         - Adds the user ID whom made the revision',
-				' comment        - Adds the comment of the revision',
-				' parsedcomment  - Adds the parsed comment of the revision',
-				' minor          - Tags if the revision is minor',
-				' len            - Adds the length (bytes) of the revision',
-				' sha1           - Adds the SHA-1 (base 16) of the revision',
-				' content        - Adds the content of the revision',
-				' token          - Gives the edit token',
-				' tags           - Tags for the revision',
+			'limit' => array(
+				ApiBase::PARAM_DFLT => 10,
+				ApiBase::PARAM_TYPE => 'limit',
+				ApiBase::PARAM_MIN => 1,
+				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+			),
+			'continue' => array(
+				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 			),
-			'namespace' => 'Only list pages in this namespace (3)',
-			'user' => 'Only list revisions by this user',
-			'excludeuser' => 'Don\'t list revisions by this user',
-			'continue' => 'When more results are available, use this to continue',
-			'unique' => 'List only one revision for each page (3)',
-			'tag' => 'Only list revisions tagged with this tag',
-		);
-	}
-
-	public function getDescription() {
-		$p = $this->getModulePrefix();
-
-		return array(
-			'List deleted revisions.',
-			'Operates in three modes:',
-			' 1) List deleted revisions for the given title(s), sorted by timestamp.',
-			' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified).',
-			' 3) List all deleted revisions in the given namespace, sorted by title and timestamp',
-			"    (no titles specified, {$p}user not set).",
-			'Certain parameters only apply to some modes and are ignored in others.',
-			'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3.',
 		);
 	}
 
-	public function getExamples() {
+	protected function getExamplesMessages() {
 		return array(
-			'api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
+			'action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
 				'drprop=user|comment|content'
-				=> 'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1)',
-			'api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50'
-				=> 'List the last 50 deleted contributions by Bob (mode 2)',
-			'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50'
-				=> 'List the first 50 deleted revisions in the main namespace (mode 3)',
-			'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
-				=> 'List the first 50 deleted pages in the Talk namespace (mode 3):',
+				=> 'apihelp-query+deletedrevs-example-mode1',
+			'action=query&list=deletedrevs&druser=Bob&drlimit=50'
+				=> 'apihelp-query+deletedrevs-example-mode2',
+			'action=query&list=deletedrevs&drdir=newer&drlimit=50'
+				=> 'apihelp-query+deletedrevs-example-mode3-main',
+			'action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
+				=> 'apihelp-query+deletedrevs-example-mode3-talk',
 		);
 	}