5ae946d3a6
Make ::setCategory() consistent with the corresponding singular method, which is ::addCategory(), not ::addCategoryLink(). Also, don't return a value. This renaming is in preparation for factoring out a write-only base class from ParserOutput suitable to be used by Parsoid. Note that OutputPage does distinguish a 'category link' from a 'category list', and there are separate OutputPage::getCategories() and OutputPage::getCategoryLinks() methods. However, the category map in ParserOutput isn't exactly the same as either of these: it's actually a map (or list of pairs) of category name to sort key. Rename ParserOutput::getCategoryLinks() to ::getCategoryNames() in order to clarify that the concept involved is not the same as the OutputPage "category links" methods. Code search: https://codesearch.wmcloud.org/deployed/?q=-%3E(get%7Cset)CategoryLinks%5C(&i=nope&files=&excludeFiles=&repos= (Note that many of the code search matches are for the methods in OutputPage, which we are trying to disambiguate here.) Bug: T287216 Change-Id: Idb383d3d9ef7b76f8a0208a057a3cb8c639465c9
97 lines
2.7 KiB
PHP
97 lines
2.7 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Search;
|
|
|
|
use Category;
|
|
use ParserOutput;
|
|
use Title;
|
|
|
|
/**
|
|
* Extracts data from ParserOutput for indexing in the search engine.
|
|
*
|
|
* 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
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @since 1.28
|
|
*/
|
|
class ParserOutputSearchDataExtractor {
|
|
|
|
/**
|
|
* Get a list of categories, as an array with title text strings.
|
|
*
|
|
* @param ParserOutput $parserOutput
|
|
* @return string[]
|
|
*/
|
|
public function getCategories( ParserOutput $parserOutput ) {
|
|
$categories = [];
|
|
|
|
foreach ( $parserOutput->getCategoryNames() as $key ) {
|
|
$name = Category::newFromName( $key )->getName();
|
|
$categories[] = str_replace( '_', ' ', $name );
|
|
}
|
|
|
|
return $categories;
|
|
}
|
|
|
|
/**
|
|
* Get a list of external links from ParserOutput, as an array of strings.
|
|
*
|
|
* @param ParserOutput $parserOutput
|
|
* @return string[]
|
|
*/
|
|
public function getExternalLinks( ParserOutput $parserOutput ) {
|
|
return array_keys( $parserOutput->getExternalLinks() );
|
|
}
|
|
|
|
/**
|
|
* Get a list of outgoing wiki links (including interwiki links), as
|
|
* an array of prefixed title strings.
|
|
*
|
|
* @param ParserOutput $parserOutput
|
|
* @return string[]
|
|
*/
|
|
public function getOutgoingLinks( ParserOutput $parserOutput ) {
|
|
$outgoingLinks = [];
|
|
|
|
foreach ( $parserOutput->getLinks() as $linkedNamespace => $namespaceLinks ) {
|
|
foreach ( array_keys( $namespaceLinks ) as $linkedDbKey ) {
|
|
$outgoingLinks[] =
|
|
Title::makeTitle( $linkedNamespace, $linkedDbKey )->getPrefixedDBkey();
|
|
}
|
|
}
|
|
|
|
return $outgoingLinks;
|
|
}
|
|
|
|
/**
|
|
* Get a list of templates used in the ParserOutput content, as prefixed title strings
|
|
*
|
|
* @param ParserOutput $parserOutput
|
|
* @return string[]
|
|
*/
|
|
public function getTemplates( ParserOutput $parserOutput ) {
|
|
$templates = [];
|
|
|
|
foreach ( $parserOutput->getTemplates() as $tNS => $templatesInNS ) {
|
|
foreach ( array_keys( $templatesInNS ) as $tDbKey ) {
|
|
$templateTitle = Title::makeTitle( $tNS, $tDbKey );
|
|
$templates[] = $templateTitle->getPrefixedText();
|
|
}
|
|
}
|
|
|
|
return $templates;
|
|
}
|
|
|
|
}
|