X-Git-Url: https://git.heureux-cyclage.org/index.php?a=blobdiff_plain;f=includes%2FAction.php;h=a9891ec7723d1ed796d503c9b0fe292f7c20b236;hb=90108d8c93735d7d5964f907b999c3a326e87461;hp=a25e8aa9ab3698a894f63535d6b6007cbd723044;hpb=7803b7cf9897de1794fdd1cc9fb1dadc4d69d7b2;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/Action.php b/includes/Action.php
index a25e8aa9ab..a9891ec772 100644
--- a/includes/Action.php
+++ b/includes/Action.php
@@ -1,15 +1,6 @@
 <?php
 /**
- * @defgroup Actions Action done on pages
- */
-
-/**
- * Actions are things which can be done to pages (edit, delete, rollback, etc).  They
- * are distinct from Special Pages because an action must apply to exactly one page.
- *
- * To add an action in an extension, create a subclass of Action, and add the key to
- * $wgActions.  There is also the deprecated UnknownAction hook
- *
+ * Base classes for actions done on pages.
  *
  * 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
@@ -27,23 +18,39 @@
  *
  * @file
  */
+
+/**
+ * @defgroup Actions Action done on pages
+ */
+
+/**
+ * Actions are things which can be done to pages (edit, delete, rollback, etc).  They
+ * are distinct from Special Pages because an action must apply to exactly one page.
+ *
+ * To add an action in an extension, create a subclass of Action, and add the key to
+ * $wgActions.  There is also the deprecated UnknownAction hook
+ *
+ * Actions generally fall into two groups: the show-a-form-then-do-something-with-the-input
+ * format (protect, delete, move, etc), and the just-do-something format (watch, rollback,
+ * patrol, etc). The FormAction and FormlessAction classes respresent these two groups.
+ */
 abstract class Action {
 
 	/**
 	 * Page on which we're performing the action
-	 * @var Page
+	 * @var Page $page
 	 */
 	protected $page;
 
 	/**
 	 * IContextSource if specified; otherwise we'll use the Context from the Page
-	 * @var IContextSource
+	 * @var IContextSource $context
 	 */
 	protected $context;
 
 	/**
 	 * The fields used to create the HTMLForm
-	 * @var Array
+	 * @var Array $fields
 	 */
 	protected $fields;
 
@@ -352,6 +359,9 @@ abstract class Action {
 	public abstract function execute();
 }
 
+/**
+ * An action which shows a form and does something based on the input from the form
+ */
 abstract class FormAction extends Action {
 
 	/**
@@ -446,8 +456,8 @@ abstract class FormAction extends Action {
 	/**
 	 * @see Action::execute()
 	 * @throws ErrorPageError
-	 * @param array|null $data
-	 * @param bool $captureErrors
+	 * @param $data array|null
+	 * @param $captureErrors bool
 	 * @return bool
 	 */
 	public function execute( array $data = null, $captureErrors = true ) {
@@ -488,9 +498,7 @@ abstract class FormAction extends Action {
 }
 
 /**
- * Actions generally fall into two groups: the show-a-form-then-do-something-with-the-input
- * format (protect, delete, move, etc), and the just-do-something format (watch, rollback,
- * patrol, etc).
+ * An action which just does something, without showing a form first.
  */
 abstract class FormlessAction extends Action {
 
@@ -509,10 +517,17 @@ abstract class FormlessAction extends Action {
 		return false;
 	}
 
+	/**
+	 * @param $data Array
+	 * @return bool
+	 */
 	public function onSubmit( $data ) {
 		return false;
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function onSuccess() {
 		return false;
 	}