$revision = Revision::newFromId( $rev1 );
if ( !$revision ) {
- $this->dieUsage( 'The diff cannot be retrieved, ' .
- 'one revision does not exist or you do not have permission to view it.', 'baddiff' );
+ $this->dieWithError( 'apierror-baddiff' );
}
$contentHandler = $revision->getContentHandler();
true,
false );
- $vals = array();
+ $vals = [];
if ( isset( $params['fromtitle'] ) ) {
$vals['fromtitle'] = $params['fromtitle'];
}
$difftext = $de->getDiffBody();
if ( $difftext === false ) {
- $this->dieUsage(
- 'The diff cannot be retrieved. Maybe one or both revisions do ' .
- 'not exist or you do not have permission to view them.',
- 'baddiff'
- );
+ $this->dieWithError( 'apierror-baddiff' );
}
- ApiResult::setContent( $vals, $difftext );
+ ApiResult::setContentValue( $vals, 'body', $difftext );
$this->getResult()->addValue( null, $this->getModuleName(), $vals );
}
} elseif ( $titleText ) {
$title = Title::newFromText( $titleText );
if ( !$title || $title->isExternal() ) {
- $this->dieUsageMsg( array( 'invalidtitle', $titleText ) );
+ $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titleText ) ] );
}
return $title->getLatestRevID();
} elseif ( $titleId ) {
$title = Title::newFromID( $titleId );
if ( !$title ) {
- $this->dieUsageMsg( array( 'nosuchpageid', $titleId ) );
+ $this->dieWithError( [ 'apierror-nosuchpageid', $titleId ] );
}
return $title->getLatestRevID();
}
- $this->dieUsage(
- 'A title, a page ID, or a revision number is needed for both the from and the to parameters',
- 'inputneeded'
- );
+ $this->dieWithError( 'apierror-compare-inputneeded', 'inputneeded' );
}
public function getAllowedParams() {
- return array(
+ return [
'fromtitle' => null,
- 'fromid' => array(
+ 'fromid' => [
ApiBase::PARAM_TYPE => 'integer'
- ),
- 'fromrev' => array(
+ ],
+ 'fromrev' => [
ApiBase::PARAM_TYPE => 'integer'
- ),
+ ],
'totitle' => null,
- 'toid' => array(
+ 'toid' => [
ApiBase::PARAM_TYPE => 'integer'
- ),
- 'torev' => array(
+ ],
+ 'torev' => [
ApiBase::PARAM_TYPE => 'integer'
- ),
- );
+ ],
+ ];
}
- public function getParamDescription() {
- return array(
- 'fromtitle' => 'First title to compare',
- 'fromid' => 'First page ID to compare',
- 'fromrev' => 'First revision to compare',
- 'totitle' => 'Second title to compare',
- 'toid' => 'Second page ID to compare',
- 'torev' => 'Second revision to compare',
- );
- }
-
- public function getResultProperties() {
- return array(
- '' => array(
- 'fromtitle' => array(
- ApiBase::PROP_TYPE => 'string',
- ApiBase::PROP_NULLABLE => true
- ),
- 'fromrevid' => 'integer',
- 'totitle' => array(
- ApiBase::PROP_TYPE => 'string',
- ApiBase::PROP_NULLABLE => true
- ),
- 'torevid' => 'integer',
- '*' => 'string'
- )
- );
- }
-
- public function getDescription() {
- return array(
- 'Get the difference between 2 pages.',
- 'You must pass a revision number or a page title or a page ID id for each part (1 and 2).'
- );
- }
-
- public function getPossibleErrors() {
- return array_merge( parent::getPossibleErrors(), array(
- array( 'code' => 'inputneeded', 'info' => 'A title or a revision is needed' ),
- array( 'invalidtitle', 'title' ),
- array( 'nosuchpageid', 'pageid' ),
- array(
- 'code' => 'baddiff',
- 'info' => 'The diff cannot be retrieved. Maybe one or both ' .
- 'revisions do not exist or you do not have permission to view them.'
- ),
- ) );
- }
-
- public function getExamples() {
- return array(
- 'api.php?action=compare&fromrev=1&torev=2' => 'Create a diff between revision 1 and 2',
- );
+ protected function getExamplesMessages() {
+ return [
+ 'action=compare&fromrev=1&torev=2'
+ => 'apihelp-compare-example-1',
+ ];
}
}