CategoriesRdf.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Category;
 
use MediaWiki\Title\Title;
use Wikimedia\Purtle\RdfWriter;
 
class CategoriesRdf {
    private const ONTOLOGY_PREFIX = 'mediawiki';
    private const ONTOLOGY_URL = 'https://www.mediawiki.org/ontology#';
    public const OWL_URL = 'https://www.mediawiki.org/ontology/ontology.owl';
    public const FORMAT_VERSION = "1.1";
    private const SPECIAL_DUMP = 'Special:CategoryDump';
 
    public function __construct(
        private readonly RdfWriter $rdfWriter,
    ) {
    }
 
    public function setupPrefixes() {
        $this->rdfWriter->prefix( self::ONTOLOGY_PREFIX, self::ONTOLOGY_URL );
        $this->rdfWriter->prefix( 'rdfs', 'http://www.w3.org/2000/01/rdf-schema#' );
        $this->rdfWriter->prefix( 'owl', 'http://www.w3.org/2002/07/owl#' );
        $this->rdfWriter->prefix( 'schema', 'http://schema.org/' );
        $this->rdfWriter->prefix( 'cc', 'http://creativecommons.org/ns#' );
    }
 
    public function writeCategoryLinkData( $fromName, $toName ) {
        $titleFrom = Title::makeTitle( NS_CATEGORY, $fromName );
        $titleTo = Title::makeTitle( NS_CATEGORY, $toName );
        $this->rdfWriter->about( $this->titleToUrl( $titleFrom ) )
            ->say( self::ONTOLOGY_PREFIX, 'isInCategory' )
            ->is( $this->titleToUrl( $titleTo ) );
    }
 
    public function writeCategoryData( $categoryName, $isHidden, $pages, $subcategories ) {
        if ( $pages < 0 ) {
            // Bugfix for T201119
            $pages = 0;
        }
        $title = Title::makeTitle( NS_CATEGORY, $categoryName );
        $this->rdfWriter->about( $this->titleToUrl( $title ) )
            ->say( 'a' )
            ->is( self::ONTOLOGY_PREFIX, 'Category' );
        if ( $isHidden ) {
            $this->rdfWriter->is( self::ONTOLOGY_PREFIX, 'HiddenCategory' );
        }
        $titletext = $title->getText();
        $this->rdfWriter->say( 'rdfs', 'label' )->value( $titletext );
        // @phan-suppress-next-line PhanTypeMismatchArgument T302667
        $this->rdfWriter->say( self::ONTOLOGY_PREFIX, 'pages' )->value( $pages );
        // @phan-suppress-next-line PhanTypeMismatchArgument T302667
        $this->rdfWriter->say( self::ONTOLOGY_PREFIX, 'subcategories' )->value( $subcategories );
        // TODO: do we want files too here? Easy to add, but don't have use case so far.
    }
 
    public function labelToUrl( $titleLabel ) {
        return $this->titleToUrl( Title::makeTitle( NS_CATEGORY, $titleLabel ) );
    }
 
    private function titleToUrl( Title $title ) {
        return $title->getFullURL( '', false, PROTO_CANONICAL );
    }
 
    public function getDumpURI() {
        return $this->titleToUrl( Title::makeTitle( NS_MAIN, self::SPECIAL_DUMP ) );
    }
 
}