X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fchanges%2FChangesListFilter.php;h=0b34a5d96996a86239f17c6c0c39d23a5a30ae3d;hb=13bb844fdfff794525e2cb202176ddee3a23ef06;hp=9af9adc01067bc50e064c3d84441a22df5eb2e38;hpb=718241d779a095f93f9f56b06e8cd647053cb79c;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/changes/ChangesListFilter.php b/includes/changes/ChangesListFilter.php index 9af9adc010..0b34a5d969 100644 --- a/includes/changes/ChangesListFilter.php +++ b/includes/changes/ChangesListFilter.php @@ -74,25 +74,25 @@ abstract class ChangesListFilter { protected $description; /** - * List of conflicting groups + * Array of associative arrays with conflict information. See + * setUnidirectionalConflict * - * @var array $conflictingGroups Array of associative arrays with conflict - * information. See setUnidirectionalConflict + * @var array $conflictingGroups */ protected $conflictingGroups = []; /** - * List of conflicting filters + * Array of associative arrays with conflict information. See + * setUnidirectionalConflict * - * @var array $conflictingFilters Array of associative arrays with conflict - * information. See setUnidirectionalConflict + * @var array $conflictingFilters */ protected $conflictingFilters = []; /** - * List of filters that are a subset of the current filter + * Array of associative arrays with subset information * - * @var array $subsetFilters Array of associative arrays with subset information + * @var array $subsetFilters */ protected $subsetFilters = []; @@ -117,23 +117,22 @@ abstract class ChangesListFilter { * UI it's for. * * @param array $filterDefinition ChangesListFilter definition - * - * $filterDefinition['name'] string Name of filter; use lowercase with no - * punctuation - * $filterDefinition['cssClassSuffix'] string CSS class suffix, used to mark - * that a particular row belongs to this filter (when a row is included by the - * filter) (optional) - * $filterDefinition['isRowApplicableCallable'] Callable taking two parameters, the - * IContextSource, and the RecentChange object for the row, and returning true if - * the row is attributed to this filter. The above CSS class will then be - * automatically added (optional, required if cssClassSuffix is used). - * $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['priority'] int Priority integer. Higher value means higher - * up in the group's filter list. + * * $filterDefinition['name'] string Name of filter; use lowercase with no + * punctuation + * * $filterDefinition['cssClassSuffix'] string CSS class suffix, used to mark + * that a particular row belongs to this filter (when a row is included by the + * filter) (optional) + * * $filterDefinition['isRowApplicableCallable'] Callable taking two parameters, the + * IContextSource, and the RecentChange object for the row, and returning true if + * the row is attributed to this filter. The above CSS class will then be + * automatically added (optional, required if cssClassSuffix is used). + * * $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['priority'] int Priority integer. Higher value means higher + * up in the group's filter list. */ public function __construct( array $filterDefinition ) { if ( isset( $filterDefinition['group'] ) ) { @@ -187,12 +186,8 @@ abstract class ChangesListFilter { * @param string $backwardKey i18n key for conflict message in reverse * direction (when in UI context of $other object) */ - public function conflictsWith( $other, $globalKey, $forwardKey, - $backwardKey ) { - - if ( $globalKey === null || $forwardKey === null || - $backwardKey === null ) { - + public function conflictsWith( $other, $globalKey, $forwardKey, $backwardKey ) { + if ( $globalKey === null || $forwardKey === null || $backwardKey === null ) { throw new MWException( 'All messages must be specified' ); } @@ -221,9 +216,7 @@ abstract class ChangesListFilter { * @param string $contextDescription i18n key for conflict message in this * direction (when in UI context of $this object) */ - public function setUnidirectionalConflict( $other, $globalDescription, - $contextDescription ) { - + public function setUnidirectionalConflict( $other, $globalDescription, $contextDescription ) { if ( $other instanceof ChangesListFilterGroup ) { $this->conflictingGroups[] = [ 'group' => $other->getName(), @@ -251,7 +244,7 @@ abstract class ChangesListFilter { * This means that anything in the results for the other filter is also in the * results for this one. * - * @param ChangesListFilter The filter the current instance is a superset of + * @param ChangesListFilter $other The filter the current instance is a superset of */ public function setAsSupersetOf( ChangesListFilter $other ) { if ( $other->getGroup() !== $this->getGroup() ) { @@ -346,7 +339,7 @@ abstract class ChangesListFilter { * * @param IContextSource $ctx Context source * @param RecentChange $rc Recent changes object - * @param Non-associative array of CSS class names; appended to if needed + * @param array &$classes Non-associative array of CSS class names; appended to if needed */ public function applyCssClassIfNeeded( IContextSource $ctx, RecentChange $rc, array &$classes ) { if ( $this->isRowApplicableCallable === null ) {