More parameter documentation

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

diff --git a/includes/api/ApiDelete.php b/includes/api/ApiDelete.php
index bfae025..bae27bb 100644 (file)
--- a/includes/api/ApiDelete.php
+++ b/includes/api/ApiDelete.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * API for MediaWiki 1.8+
+ *
  *
  * Created on Jun 30, 2007
  *
- * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,7 +30,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 }
 
 /**
- * API module that facilitates deleting pages. The API eqivalent of action=delete.
+ * API module that facilitates deleting pages. The API equivalent of action=delete.
  * Requires API write mode to be enabled.
  *
  * @ingroup API
@@ -146,7 +146,7 @@ class ApiDelete extends ApiBase {
                }
 
                $error = '';
-               if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $error ) ) ) {
+               if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, &$error ) ) ) {
                        return array( array( 'hookaborted', $error ) );
                }
 
@@ -161,7 +161,7 @@ class ApiDelete extends ApiBase {
        /**
         * @static
         * @param $token
-        * @param $title
+        * @param $title Title
         * @param $oldimage
         * @param $reason
         * @param $suppress bool
@@ -232,7 +232,7 @@ class ApiDelete extends ApiBase {
                                ApiBase::PARAM_DFLT => false,
                                ApiBase::PARAM_DEPRECATED => true,
                        ),
-                       'oldimage' => null
+                       'oldimage' => null,
                );
        }
 
@@ -256,6 +256,8 @@ class ApiDelete extends ApiBase {
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
+                       array( 'code' => 'missingparam', 'info' => 'One of the parameters title, pageid is required' ),
+                       array( 'code' => 'invalidparammix', 'info' => 'The parameters title, pageid can not be used together' ),
                        array( 'invalidtitle', 'title' ),
                        array( 'nosuchpageid', 'pageid' ),
                        array( 'notanarticle' ),