X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=blobdiff_plain;f=includes%2Fchanges%2FChangesListBooleanFilter.php;h=01e67f5079b2fb40fe2a889a11e5074fef7641c4;hp=1c116ab50a6d93ab5cb1f62c90a1cc2a2aef66a7;hb=6c9a2923fe1ee3a65cb027be5e781772f2b12fbd;hpb=6c81cf528d442d0cb10d0339440e8b104450df41

diff --git a/includes/changes/ChangesListBooleanFilter.php b/includes/changes/ChangesListBooleanFilter.php
index 1c116ab50a..01e67f5079 100644
--- a/includes/changes/ChangesListBooleanFilter.php
+++ b/includes/changes/ChangesListBooleanFilter.php
@@ -30,12 +30,6 @@ use Wikimedia\Rdbms\IDatabase;
  * @since 1.29
  */
 class ChangesListBooleanFilter extends ChangesListFilter {
-	/**
-	 * Name.  Used as URL parameter
-	 *
-	 * @var string $name
-	 */
-
 	// This can sometimes be different on Special:RecentChanges
 	// and Special:Watchlist, due to the double-legacy hooks
 	// (SpecialRecentChangesFilters and SpecialWatchlistFilters)
@@ -84,32 +78,31 @@ class ChangesListBooleanFilter extends ChangesListFilter {
 	 * it's for.
 	 *
 	 * @param array $filterDefinition ChangesListFilter definition
-	 *
-	 * $filterDefinition['name'] string Name.  Used as URL parameter.
-	 * $filterDefinition['group'] ChangesListFilterGroup Group.  Filter group this
-	 *  belongs to.
-	 * $filterDefinition['label'] string i18n key of label for structured UI.
-	 * $filterDefinition['description'] string i18n key of description for structured
-	 *  UI.
-	 * $filterDefinition['showHide'] string Main i18n key used for unstructured UI.
-	 * $filterDefinition['isReplacedInStructuredUi'] bool Whether there is an
-	 *  equivalent feature available in the structured UI; this is optional, defaulting
-	 *  to true.  It does not need to be set if the exact same filter is simply visible
-	 *  on both.
-	 * $filterDefinition['default'] bool Default
-	 * $filterDefinition['priority'] int Priority integer.  Higher value means higher
-	 *  up in the group's filter list.
-	 * $filterDefinition['queryCallable'] callable Callable accepting parameters, used
-	 *  to implement filter's DB query modification.  Callback parameters:
-	 *   string $specialPageClassName Class name of current special page
-	 *   IContextSource $context Context, for e.g. user
-	 *   IDatabase $dbr Database, for addQuotes, makeList, and similar
-	 *   array &$tables Array of tables; see IDatabase::select $table
-	 *   array &$fields Array of fields; see IDatabase::select $vars
-	 *   array &$conds Array of conditions; see IDatabase::select $conds
-	 *   array &$query_options Array of query options; see IDatabase::select $options
-	 *   array &$join_conds Array of join conditions; see IDatabase::select $join_conds
-	 *   Optional only for legacy filters that still use the query hooks directly
+	 * * $filterDefinition['name'] string Name.  Used as URL parameter.
+	 * * $filterDefinition['group'] ChangesListFilterGroup Group.  Filter group this
+	 *     belongs to.
+	 * * $filterDefinition['label'] string i18n key of label for structured UI.
+	 * * $filterDefinition['description'] string i18n key of description for structured
+	 *     UI.
+	 * * $filterDefinition['showHide'] string Main i18n key used for unstructured UI.
+	 * * $filterDefinition['isReplacedInStructuredUi'] bool Whether there is an
+	 *     equivalent feature available in the structured UI; this is optional, defaulting
+	 *     to true.  It does not need to be set if the exact same filter is simply visible
+	 *     on both.
+	 * * $filterDefinition['default'] bool Default
+	 * * $filterDefinition['priority'] int Priority integer.  Higher value means higher
+	 *     up in the group's filter list.
+	 * * $filterDefinition['queryCallable'] callable Callable accepting parameters, used
+	 *     to implement filter's DB query modification.  Required, except for legacy
+	 *     filters that still use the query hooks directly.  Callback parameters:
+	 * 	* string $specialPageClassName Class name of current special page
+	 * 	* IContextSource $context Context, for e.g. user
+	 * 	* IDatabase $dbr Database, for addQuotes, makeList, and similar
+	 * 	* array &$tables Array of tables; see IDatabase::select $table
+	 * 	* array &$fields Array of fields; see IDatabase::select $vars
+	 * 	* array &$conds Array of conditions; see IDatabase::select $conds
+	 * 	* array &$query_options Array of query options; see IDatabase::select $options
+	 * 	* array &$join_conds Array of join conditions; see IDatabase::select $join_conds
 	 */
 	public function __construct( $filterDefinition ) {
 		parent::__construct( $filterDefinition );
@@ -150,7 +143,7 @@ class ChangesListBooleanFilter extends ChangesListFilter {
 	/**
 	 * Sets default
 	 *
-	 * @param bool Default value
+	 * @param bool $defaultValue
 	 */
 	public function setDefault( $defaultValue ) {
 		$this->defaultValue = $defaultValue;
@@ -164,14 +157,14 @@ class ChangesListBooleanFilter extends ChangesListFilter {
 	}
 
 	/**
-	 * @inheritdoc
+	 * @inheritDoc
 	 */
 	public function displaysOnUnstructuredUi() {
 		return !!$this->showHide;
 	}
 
 	/**
-	 * @inheritdoc
+	 * @inheritDoc
 	 */
 	public function isFeatureAvailableOnStructuredUi() {
 		return $this->isReplacedInStructuredUi ||
@@ -191,8 +184,8 @@ class ChangesListBooleanFilter extends ChangesListFilter {
 	 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
 	 */
 	public function modifyQuery( IDatabase $dbr, ChangesListSpecialPage $specialPage,
-		&$tables, &$fields, &$conds, &$query_options, &$join_conds ) {
-
+		&$tables, &$fields, &$conds, &$query_options, &$join_conds
+	) {
 		if ( $this->queryCallable === null ) {
 			return;
 		}
@@ -213,7 +206,7 @@ class ChangesListBooleanFilter extends ChangesListFilter {
 	}
 
 	/**
-	 * @inheritdoc
+	 * @inheritDoc
 	 */
 	public function getJsData() {
 		$output = parent::getJsData();
@@ -224,7 +217,7 @@ class ChangesListBooleanFilter extends ChangesListFilter {
 	}
 
 	/**
-	 * @inheritdoc
+	 * @inheritDoc
 	 */
 	public function isSelected( FormOptions $opts ) {
 		return !$opts[ $this->getName() ] &&