Merge "Rollback transaction in case of uncaught exceptions during job"

[lhc/web/wiklou.git] / includes / api / ApiRevisionDelete.php

diff --git a/includes/api/ApiRevisionDelete.php b/includes/api/ApiRevisionDelete.php
index 55d59f4..2c76f37 100644 (file)
--- a/includes/api/ApiRevisionDelete.php
+++ b/includes/api/ApiRevisionDelete.php
@@ -97,14 +97,19 @@ class ApiRevisionDelete extends ApiBase {
                $data = $this->extractStatusInfo( $status );
                $data['target'] = $targetObj->getFullText();
                $data['items'] = array();
+
                foreach ( $status->itemStatuses as $id => $s ) {
                        $data['items'][$id] = $this->extractStatusInfo( $s );
                        $data['items'][$id]['id'] = $id;
                }
+
                $list->reloadFromMaster();
+               // @codingStandardsIgnoreStart Avoid function calls in a FOR loop test part
                for ( $item = $list->reset(); $list->current(); $item = $list->next() ) {
                        $data['items'][$item->getId()] += $item->getApiData( $this->getResult() );
                }
+               // @codingStandardsIgnoreEnd
+
                $data['items'] = array_values( $data['items'] );
                $result->setIndexedTagName( $data['items'], 'i' );
                $result->addValue( null, $this->getModuleName(), $data );
@@ -124,6 +129,7 @@ class ApiRevisionDelete extends ApiBase {
                        $this->getResult()->setIndexedTagName( $warnings, 'w' );
                        $ret['warnings'] = $warnings;
                }
+
                return $ret;
        }
 
@@ -154,6 +160,7 @@ class ApiRevisionDelete extends ApiBase {
                        $message['rendered'] = $msg->useDatabase( false )->inLanguage( 'en' )->plain();
                        $ret[] = $message;
                }
+
                return $ret;
        }
 
@@ -210,14 +217,15 @@ class ApiRevisionDelete extends ApiBase {
        }
 
        public function getDescription() {
-               return 'Delete/undelete revisions';
+               return 'Delete/undelete revisions.';
        }
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(),
                        array(
-                               'needtarget' => 'A target title is required for this RevDel type',
-                               'badparams' => 'Bad value for some parameter',
+                               array( 'code' => 'needtarget',
+                                       'info' => 'A target title is required for this RevDel type' ),
+                               array( 'code' => 'badparams', 'info' => 'Bad value for some parameter' ),
                        )
                );
        }
@@ -232,10 +240,12 @@ class ApiRevisionDelete extends ApiBase {
 
        public function getExamples() {
                return array(
-                       'api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&hide=content&token=123ABC'
-                       => 'Hide content for revision 12345 on the Main Page',
-                       'api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&reason=BLP%20violation&token=123ABC'
-                       => 'Hide all data on log entry 67890 with the reason "BLP violation"',
+                       'api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&' .
+                               'hide=content&token=123ABC'
+                               => 'Hide content for revision 12345 on the Main Page',
+                       'api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&' .
+                               'reason=BLP%20violation&token=123ABC'
+                               => 'Hide all data on log entry 67890 with the reason "BLP violation"',
                );
        }