Page MenuHomeGitPull.it

Snak.php
No OneTemporary

Authored By
Unknown
Size
6 KB
Referenced Files
None
Subscribers
None

Snak.php

<?php
# Boz-MW - Another MediaWiki API handler in PHP
# Copyright (C) 2017, 2018, 2019, 2020 Valerio Bozzolan
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Wikibase
namespace wb;
/**
* A generic Snak is a combination of a property and a datatype + datavalue.
*
* A Snak is part of a Claim or a Reference. It's based on a DataValue.
*/
class Snak {
private $hash;
private $snaktype;
private $property;
private $datatype;
private $datavalue;
/**
* @param $snaktype string
* @param $property string
* @param $datatype string
* @param $datavalue mixed
*/
public function __construct( $snaktype, $property, $datatype, $datavalue = null ) {
$this->setSnakType( $snaktype )
->setProperty( $property )
->setDataType( $datatype );
if( null !== $datavalue ) {
$this->setDataValue( $datavalue );
}
}
/**
* Get the property
*
* @return string
*/
public function getProperty() {
return $this->property;
}
/**
* Get the snak type
*/
public function getSnakType() {
return $this->snaktype;
}
/**
* Get the data type
*/
public function getDataType() {
return $this->datatype;
}
/**
* Get the data value
*
* @return DataValue
*/
public function getDataValue() {
return $this->datavalue;
}
/**
* Set the snak type
*
* @param $snaktype
* @param self
*/
public function setSnakType( $snaktype ) {
$this->snaktype = $snaktype;
return $this;
}
/**
* Set the property
*
* @param $property string
* @param self
*/
public function setProperty( $property ) {
$this->property = $property;
return $this;
}
/**
* Get an human property label, if available in cache
*/
public function getPropertyLabel() {
return self::propertyLabel( $this->getProperty() );
}
/**
* Set the data type
*
* @param $datatype
* @param self
*/
public function setDataType( $datatype ) {
$this->datatype = $datatype;
return $this;
}
/**
* Set the data value
*
* @param $datavalue DataValue
* @param self
*/
public function setDataValue( DataValue $datavalue ) {
$this->datavalue = $datavalue;
return $this;
}
/**
* Check if the snak has an hash
*
* @return bool
*/
public function hasHash() {
return isset( $this->hash );
}
/**
* Get the hash
*
* @return string|null
*/
public function getHash() {
return $this->hash;
}
/**
* Set the hash
*
* @param $hash string
* @return self
*/
public function setHash( $hash ) {
$this->hash = $hash;
return $this;
}
/**
* Get a wikilink to this property
*
* This may be awared about which is the wiki that will contain this value,
* in order to properly choose a correct permalink in wikilinks etc.
*
* See https://gitpull.it/T221
*
* @param $site object You can eventually specify in which site you want to print this value
* @return string
*/
protected function getPropertyWLink( \mw\Site $site = null ) {
/**
* If you are on every wiki but Wikidata,
* links to items and properties will fail without
* an interwiki prefix.
*
* See https://gitpull.it/T221
*/
$prefix = '';
if( $site && $site::UID !== 'wikidatawiki' ) {
$prefix = 'wikidata:';
}
$prop = $this->getProperty();
$label = $this->getPropertyLabel();
if( !$label ) {
$label = $prop;
}
return sprintf( '[[%sP:%s|%s]]', $prefix, $prop, $label );
}
/**
* Try to read the property label from the cache
*
* @TODO: ask also the site
* @return string|false
*/
public static function propertyLabel( $property ) {
return \wm\Wikidata::propertyLabel( $property );
}
/**
* Create a snak from raw data
*
* @param $data array
* @return self
*/
public static function createFromData( $data ) {
/**
* Check if the data has these attributes
*
* Note that Wikimedia Commons' Structured Data may
* not return any 'datatype'.
*
* See https://gitpull.it/T223
* See https://phabricator.wikimedia.org/T246809
*/
$required_attributes = [
'snaktype',
'property',
// 'datatype',
];
foreach( $required_attributes as $required_attribute ) {
if( !isset( $data[ $required_attribute ] ) ) {
throw new WrongDataException( __CLASS__, "missing $required_attribute" );
}
}
// create the Snak
$snak = new self(
$data['snaktype'],
$data['property'],
$data['datatype'] ?? null
);
// eventually set the DataValue
if( isset( $data['datavalue'] ) ) {
$snak->setDataValue( DataValue::createFromData( $data['datavalue'] ) );
}
// eventually set the hash
if( isset( $data['hash'] ) ) {
$snak->setHash( $data['hash'] );
}
// that's all
return $snak;
}
/**
* Convert this object to an associative array suitable for JSON encoding
*
* @return array
*/
public function toData() {
$data = [];
// it may have an hash
if( $this->hasHash() ) {
$data['hash'] = $this->getHash();
}
$data['snaktype'] = $this->getSnakType();
$data['property'] = $this->getProperty();
$data['datatype'] = $this->getDataType();
$data['datavalue'] = $this->getDataValue();
if( $data['datavalue'] ) {
$data['datavalue'] = $data['datavalue']->toData();
}
return $data;
}
/**
* Get a wikitext-compatible version of this value
*
* This may be awared about which is the wiki that will contain this value,
* in order to properly choose a correct permalink in wikilinks etc.
*
* See https://gitpull.it/T221
*
* @param $site object You can eventually specify in which site you want to print this value
* @return string
*/
public function toPrintableWikitext( \mw\Site $site = null ) {
return sprintf( '%s: %s',
$this->getPropertyWLink( $site ),
$this->getDataValue()->toPrintableWikitext( $site )
);
}
/**
* @return string
*/
public function __toString() {
return $this->toPrintableWikitext();
}
}

File Metadata

Mime Type
text/x-php
Expires
Thu, Nov 19, 06:41 (3 h, 58 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2265215
Default Alt Text
Snak.php (6 KB)

Event Timeline