home/omtekel/wiki/includes/changes/ChangesListFilterGroup.php000066600000033253151335340260020431 0ustar00name = $groupDefinition['name']; if ( isset( $groupDefinition['title'] ) ) { $this->title = $groupDefinition['title']; } if ( isset( $groupDefinition['whatsThisHeader'] ) ) { $this->whatsThisHeader = $groupDefinition['whatsThisHeader']; $this->whatsThisBody = $groupDefinition['whatsThisBody']; $this->whatsThisUrl = $groupDefinition['whatsThisUrl']; $this->whatsThisLinkText = $groupDefinition['whatsThisLinkText']; } $this->type = $groupDefinition['type']; $this->priority = $groupDefinition['priority'] ?? self::DEFAULT_PRIORITY; $this->isFullCoverage = $groupDefinition['isFullCoverage']; $this->filters = []; $lowestSpecifiedPriority = -1; foreach ( $groupDefinition['filters'] as $filterDefinition ) { if ( isset( $filterDefinition['priority'] ) ) { $lowestSpecifiedPriority = min( $lowestSpecifiedPriority, $filterDefinition['priority'] ); } } // Convenience feature: If you specify a group (and its filters) all in // one place, you don't have to specify priority. You can just put them // in order. However, if you later add one (e.g. an extension adds a filter // to a core-defined group), you need to specify it. $autoFillPriority = $lowestSpecifiedPriority - 1; foreach ( $groupDefinition['filters'] as $filterDefinition ) { if ( !isset( $filterDefinition['priority'] ) ) { $filterDefinition['priority'] = $autoFillPriority; $autoFillPriority--; } $filterDefinition['group'] = $this; $filter = $this->createFilter( $filterDefinition ); $this->registerFilter( $filter ); } } /** * Creates a filter of the appropriate type for this group, from the definition * * @param array $filterDefinition * @return ChangesListFilter Filter */ abstract protected function createFilter( array $filterDefinition ); /** * Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object. * * WARNING: This means there is a conflict when both things are *shown* * (not filtered out), even for the hide-based filters. So e.g. conflicting with * 'hideanons' means there is a conflict if only anonymous users are *shown*. * * @param ChangesListFilterGroup|ChangesListFilter $other * @param string $globalKey i18n key for top-level conflict message * @param string $forwardKey i18n key for conflict message in this * direction (when in UI context of $this object) * @param string $backwardKey i18n key for conflict message in reverse * direction (when in UI context of $other object) */ public function conflictsWith( $other, string $globalKey, string $forwardKey, string $backwardKey ) { $this->setUnidirectionalConflict( $other, $globalKey, $forwardKey ); $other->setUnidirectionalConflict( $this, $globalKey, $backwardKey ); } /** * Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with * this object. * * Internal use ONLY. * * @param ChangesListFilterGroup|ChangesListFilter $other * @param string $globalDescription i18n key for top-level conflict message * @param string $contextDescription i18n key for conflict message in this * direction (when in UI context of $this object) */ public function setUnidirectionalConflict( $other, $globalDescription, $contextDescription ) { if ( $other instanceof ChangesListFilterGroup ) { $this->conflictingGroups[] = [ 'group' => $other->getName(), 'groupObject' => $other, 'globalDescription' => $globalDescription, 'contextDescription' => $contextDescription, ]; } elseif ( $other instanceof ChangesListFilter ) { $this->conflictingFilters[] = [ 'group' => $other->getGroup()->getName(), 'filter' => $other->getName(), 'filterObject' => $other, 'globalDescription' => $globalDescription, 'contextDescription' => $contextDescription, ]; } else { throw new InvalidArgumentException( 'You can only pass in a ChangesListFilterGroup or a ChangesListFilter' ); } } /** * @return string Internal name */ public function getName() { return $this->name; } /** * @return string i18n key for title */ public function getTitle() { return $this->title; } /** * @return string Type (TYPE constant from a subclass) */ public function getType() { return $this->type; } /** * @return int Priority. Higher means higher in the group list */ public function getPriority() { return $this->priority; } /** * @return ChangesListFilter[] Associative array of ChangesListFilter objects, with * filter name as key */ public function getFilters() { return $this->filters; } /** * Get filter by name * * @param string $name Filter name * @return ChangesListFilter|null Specified filter, or null if it is not registered */ public function getFilter( $name ) { return $this->filters[$name] ?? null; } /** * Gets the JS data in the format required by the front-end of the structured UI * * @return array|null Associative array, or null if there are no filters that * display in the structured UI. messageKeys is a special top-level value, with * the value being an array of the message keys to send to the client. */ public function getJsData() { $output = [ 'name' => $this->name, 'type' => $this->type, 'fullCoverage' => $this->isFullCoverage, 'filters' => [], 'priority' => $this->priority, 'conflicts' => [], 'messageKeys' => [ $this->title ] ]; if ( isset( $this->whatsThisHeader ) ) { $output['whatsThisHeader'] = $this->whatsThisHeader; $output['whatsThisBody'] = $this->whatsThisBody; $output['whatsThisUrl'] = $this->whatsThisUrl; $output['whatsThisLinkText'] = $this->whatsThisLinkText; array_push( $output['messageKeys'], $output['whatsThisHeader'], $output['whatsThisBody'], $output['whatsThisLinkText'] ); } usort( $this->filters, static function ( ChangesListFilter $a, ChangesListFilter $b ) { return $b->getPriority() <=> $a->getPriority(); } ); foreach ( $this->filters as $filter ) { if ( $filter->displaysOnStructuredUi() ) { $filterData = $filter->getJsData(); $output['messageKeys'] = array_merge( $output['messageKeys'], $filterData['messageKeys'] ); unset( $filterData['messageKeys'] ); $output['filters'][] = $filterData; } } if ( count( $output['filters'] ) === 0 ) { return null; } $output['title'] = $this->title; $conflicts = array_merge( $this->conflictingGroups, $this->conflictingFilters ); foreach ( $conflicts as $conflictInfo ) { unset( $conflictInfo['filterObject'] ); unset( $conflictInfo['groupObject'] ); $output['conflicts'][] = $conflictInfo; array_push( $output['messageKeys'], $conflictInfo['globalDescription'], $conflictInfo['contextDescription'] ); } return $output; } /** * Get groups conflicting with this filter group * * @return ChangesListFilterGroup[] */ public function getConflictingGroups() { return array_column( $this->conflictingGroups, 'groupObject' ); } /** * Get filters conflicting with this filter group * * @return ChangesListFilter[] */ public function getConflictingFilters() { return array_column( $this->conflictingFilters, 'filterObject' ); } /** * Check if any filter in this group is selected * * @param FormOptions $opts * @return bool */ public function anySelected( FormOptions $opts ) { return (bool)count( array_filter( $this->getFilters(), static function ( ChangesListFilter $filter ) use ( $opts ) { return $filter->isSelected( $opts ); } ) ); } /** * Modifies the query to include the filter group. * * The modification is only done if the filter group is in effect. This means that * one or more valid and allowed filters were selected. * * @param IReadableDatabase $dbr Database, for addQuotes, makeList, and similar * @param ChangesListSpecialPage $specialPage Current special page * @param array &$tables Array of tables; see IDatabase::select $table * @param array &$fields Array of fields; see IDatabase::select $vars * @param array &$conds Array of conditions; see IDatabase::select $conds * @param array &$query_options Array of query options; see IDatabase::select $options * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds * @param FormOptions $opts Wrapper for the current request options and their defaults * @param bool $isStructuredFiltersEnabled True if the Structured UI is currently enabled */ abstract public function modifyQuery( IReadableDatabase $dbr, ChangesListSpecialPage $specialPage, &$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts, $isStructuredFiltersEnabled ); /** * All the options represented by this filter group to $opts * * @param FormOptions $opts * @param bool $allowDefaults * @param bool $isStructuredFiltersEnabled */ abstract public function addOptions( FormOptions $opts, $allowDefaults, $isStructuredFiltersEnabled ); }