MediaWiki  master
CategoriesRdf Class Reference

Helper class to produce RDF representation of categories. More...

Collaboration diagram for CategoriesRdf:

Public Member Functions

 __construct (RdfWriter $writer)
 
 getDumpURI ()
 Get URI of the dump for this particular wiki. More...
 
 labelToUrl ( $titleLabel)
 Make URL from title label. More...
 
 setupPrefixes ()
 Setup prefixes relevant for the dump. More...
 
 writeCategoryData ( $categoryName, $isHidden, $pages, $subcategories)
 Write out the data for single category. More...
 
 writeCategoryLinkData ( $fromName, $toName)
 Write RDF data for link between categories. More...
 

Public Attributes

const FORMAT_VERSION = "1.1"
 Current version of the dump format. More...
 
const ONTOLOGY_PREFIX = 'mediawiki'
 Prefix used for Mediawiki ontology in the dump. More...
 
const ONTOLOGY_URL = 'https://www.mediawiki.org/ontology#'
 Base URL for Mediawiki ontology. More...
 
const OWL_URL = 'https://www.mediawiki.org/ontology/ontology.owl'
 OWL description of the ontology. More...
 
const SPECIAL_DUMP = 'Special:CategoryDump'
 Special page for Dump identification. More...
 

Private Member Functions

 titleToUrl (Title $title)
 Convert Title to link to target page. More...
 

Private Attributes

RdfWriter $rdfWriter
 

Detailed Description

Helper class to produce RDF representation of categories.

Definition at line 24 of file CategoriesRdf.php.

Constructor & Destructor Documentation

◆ __construct()

CategoriesRdf::__construct ( RdfWriter  $writer)

Definition at line 52 of file CategoriesRdf.php.

Member Function Documentation

◆ getDumpURI()

CategoriesRdf::getDumpURI ( )

Get URI of the dump for this particular wiki.

Returns
false|string

Definition at line 128 of file CategoriesRdf.php.

References Title\makeTitle(), NS_MAIN, and titleToUrl().

◆ labelToUrl()

CategoriesRdf::labelToUrl (   $titleLabel)

Make URL from title label.

Parameters
string$titleLabelShort label (without namespace) of the category
Returns
string URL for the category

Definition at line 111 of file CategoriesRdf.php.

References Title\makeTitle(), NS_CATEGORY, and titleToUrl().

◆ setupPrefixes()

CategoriesRdf::setupPrefixes ( )

Setup prefixes relevant for the dump.

Definition at line 59 of file CategoriesRdf.php.

◆ titleToUrl()

CategoriesRdf::titleToUrl ( Title  $title)
private

Convert Title to link to target page.

Parameters
Title$title
Returns
string URL for the category

Definition at line 120 of file CategoriesRdf.php.

References Title\getFullURL(), and PROTO_CANONICAL.

Referenced by getDumpURI(), labelToUrl(), writeCategoryData(), and writeCategoryLinkData().

◆ writeCategoryData()

CategoriesRdf::writeCategoryData (   $categoryName,
  $isHidden,
  $pages,
  $subcategories 
)

Write out the data for single category.

Parameters
string$categoryNameCategory name
bool$isHiddenHidden category?
int$pagesPage count (note this includes only Wiki articles, not subcats or files)
int$subcategoriesSubcategory count

Definition at line 87 of file CategoriesRdf.php.

References $title, Title\makeTitle(), NS_CATEGORY, and titleToUrl().

◆ writeCategoryLinkData()

CategoriesRdf::writeCategoryLinkData (   $fromName,
  $toName 
)

Write RDF data for link between categories.

Parameters
string$fromNameChild category name
string$toNameParent category name

Definition at line 72 of file CategoriesRdf.php.

References Title\makeTitle(), NS_CATEGORY, and titleToUrl().

Member Data Documentation

◆ $rdfWriter

RdfWriter CategoriesRdf::$rdfWriter
private

Definition at line 50 of file CategoriesRdf.php.

◆ FORMAT_VERSION

const CategoriesRdf::FORMAT_VERSION = "1.1"

Current version of the dump format.

Definition at line 40 of file CategoriesRdf.php.

Referenced by DumpCategoriesAsRdf\addDumpHeader().

◆ ONTOLOGY_PREFIX

const CategoriesRdf::ONTOLOGY_PREFIX = 'mediawiki'

Prefix used for Mediawiki ontology in the dump.

Definition at line 28 of file CategoriesRdf.php.

◆ ONTOLOGY_URL

const CategoriesRdf::ONTOLOGY_URL = 'https://www.mediawiki.org/ontology#'

Base URL for Mediawiki ontology.

Definition at line 32 of file CategoriesRdf.php.

◆ OWL_URL

const CategoriesRdf::OWL_URL = 'https://www.mediawiki.org/ontology/ontology.owl'

OWL description of the ontology.

Definition at line 36 of file CategoriesRdf.php.

Referenced by DumpCategoriesAsRdf\addDumpHeader().

◆ SPECIAL_DUMP

const CategoriesRdf::SPECIAL_DUMP = 'Special:CategoryDump'

Special page for Dump identification.

Used as head URI for each wiki's category dump, e.g.: https://en.wikipedia.org/wiki/Special:CategoryDump

Definition at line 46 of file CategoriesRdf.php.


The documentation for this class was generated from the following file: