isTOCABTestEnabled() ) { $options['toc'] = !$this->isTableOfContentsVisibleInSidebar(); } parent::__construct( $options ); } /** * @internal * @return bool */ public function isTOCABTestEnabled(): bool { $experimentConfig = $this->getConfig()->get( Constants::CONFIG_WEB_AB_TEST_ENROLLMENT ); return $experimentConfig['name'] === self::TOC_AB_TEST_NAME && $experimentConfig['enabled'] && MediaWikiServices::getInstance()->hasService( Constants::WEB_AB_TEST_ARTICLE_ID_FACTORY_SERVICE ); } /** * Returns whether or not the table of contents is enabled through * FeatureManager. * * @internal * @return bool */ public function isTOCEnabled() { $featureManager = VectorServices::getFeatureManager(); return $featureManager->isFeatureEnabled( Constants::FEATURE_TABLE_OF_CONTENTS ); } /** * Determines if the Table of Contents should be visible. * TOC is visible on main namespaces except for the Main Page * when the feature flag is on. * * @internal * @return bool */ public function isTableOfContentsVisibleInSidebar(): bool { $title = $this->getTitle(); if ( !$title || $title->isMainPage() ) { return false; } if ( $this->isTOCABTestEnabled() ) { return $title->getArticleID() !== 0; } return $this->isTOCEnabled(); } /** * Annotates table of contents data with Vector-specific information. * * @param array $tocData * @return array */ private function getTocData( array $tocData ): array { // If the table of contents has no items, we won't output it. // empty array is interpreted by Mustache as falsey. if ( empty( $tocData ) || empty( $tocData[ 'array-sections' ] ) ) { return []; } // Populate button labels for collapsible TOC sections foreach ( $tocData[ 'array-sections' ] as &$section ) { if ( $section['is-top-level-section'] && $section['is-parent-section'] ) { $section['vector-button-label'] = $this->msg( 'vector-toc-toggle-button-label', $section['line'] )->text(); } } return array_merge( $tocData, [ 'is-vector-toc-beginning-enabled' => $this->getConfig()->get( 'VectorTableOfContentsBeginning' ), 'vector-is-collapse-sections-enabled' => $tocData[ 'number-section-count'] >= $this->getConfig()->get( 'VectorTableOfContentsCollapseAtCount' ) ] ); } /** * Temporary function while we deprecate SkinVector class. * * @return bool */ protected function isLegacy(): bool { return false; } /** * Merges the `view-overflow` menu into the `action` menu. * This ensures that the previous state of the menu e.g. emptyPortlet class * is preserved. * @param array $data * @return array */ private function mergeViewOverflowIntoActions( $data ) { $portlets = $data['data-portlets']; $actions = $portlets['data-actions']; $overflow = $portlets['data-views-overflow']; // if the views overflow menu is not empty, then signal that the more menu despite // being initially empty now has collapsible items. if ( !$overflow['is-empty'] ) { $data['data-portlets']['data-actions']['class'] .= ' vector-has-collapsible-items'; } $data['data-portlets']['data-actions']['html-items'] = $overflow['html-items'] . $actions['html-items']; return $data; } /** * @return array */ public function getTemplateData(): array { $featureManager = VectorServices::getFeatureManager(); $parentData = parent::getTemplateData(); $parentData['data-toc'] = $this->getTocData( $parentData['data-toc'] ?? [] ); if ( !$this->isTableOfContentsVisibleInSidebar() ) { unset( $parentData['data-toc'] ); } $parentData = $this->mergeViewOverflowIntoActions( $parentData ); $isGrid = $featureManager->isFeatureEnabled( Constants::FEATURE_GRID ); return $parentData + [ 'is-vector-grid' => $isGrid, 'vector-layout-class' => $isGrid ? 'vector-layout-grid vector-toc-visible' : 'vector-layout-legacy', 'data-vector-sticky-header' => $featureManager->isFeatureEnabled( Constants::FEATURE_STICKY_HEADER ) ? $this->getStickyHeaderData( $this->getSearchData( $parentData['data-search-box'], // Collapse inside search box is disabled. false, false, 'vector-sticky-search-form', false ), $featureManager->isFeatureEnabled( Constants::FEATURE_STICKY_HEADER_EDIT ) ) : false, 'is-title-above-tabs' => $featureManager->isFeatureEnabled( Constants::FEATURE_TITLE_ABOVE_TABS ) ]; } }