samwilson / simple-wikidata

examples/custom_entity_types.php

Spacing +6 added lines, -6 removed lines

@@ -3,7 +3,7 @@ 
 require_once __DIR__ . '/../vendor/autoload.php';
 
 // Any PSR6 cache can be used.
-$cache = new Stash\Pool( new \Stash\Driver\FileSystem() );
+$cache = new Stash\Pool(new \Stash\Driver\FileSystem());
 
 // @codingStandardsIgnoreStart
 /**
@@ -23,7 +23,7 @@ 
 	 * @return RailwayStation[]
 	 */
 	public function hasAdjacentStations() {
-		return $this->getPropertyOfTypeItem( 'P197' );
+		return $this->getPropertyOfTypeItem('P197');
 	}
 	/**
 	 * Including queries.
@@ -31,7 +31,7 @@ 
 	 */
 	public function isAdjacentTo() {
 		$sparql = "SELECT ?item WHERE { ?item wdt:P197 wd:" . $this->getId() . " }";
-		$query = new \Samwilson\SimpleWikidata\Query( $sparql, $this->lang, $this->cache );
+		$query = new \Samwilson\SimpleWikidata\Query($sparql, $this->lang, $this->cache);
 		// Each query result will also be a RailwayStation
 		// (if they're correctly recorded as such on Wikidata).
 		return $query->getItems();
@@ -43,7 +43,7 @@ 
 
 // Then we can create items with the factory and use them.
 /** @var RailwayStation $eustonStation */
-$eustonStation = \Samwilson\SimpleWikidata\Item::factory( 'Q800751', 'en', $cache );
+$eustonStation = \Samwilson\SimpleWikidata\Item::factory('Q800751', 'en', $cache);
 echo $eustonStation->getLabel()
-	. " has " . count( $eustonStation->hasAdjacentStations() ) . " adjacent stations"
-	. " and is adjacent to " . count( $eustonStation->isAdjacentTo() ) . " stations.\n";
+	. " has " . count($eustonStation->hasAdjacentStations()) . " adjacent stations"
+	. " and is adjacent to " . count($eustonStation->isAdjacentTo()) . " stations.\n";

src/Item.php

Spacing +120 added lines, -120 removed lines

@@ -38,12 +38,12 @@ 
 	/** @var string The base URL of Wikidata, with trailing slash. */
 	protected $wikidataUrlBase = 'https://www.wikidata.org/wiki/';
 
-	private function __construct( $id, $lang, CacheItemPoolInterface $cache ) {
-		if ( !is_string( $id ) || preg_match( '/[QP][0-9]*/i', $id ) !== 1 ) {
-			throw new Exception( "Not a valid ID: " . var_export( $id, true ) );
+	private function __construct($id, $lang, CacheItemPoolInterface $cache) {
+		if (!is_string($id) || preg_match('/[QP][0-9]*/i', $id) !== 1) {
+			throw new Exception("Not a valid ID: " . var_export($id, true));
 		}
 		$this->id = $id;
-		$this->wdApi = new MediawikiApi( 'https://www.wikidata.org/w/api.php' );
+		$this->wdApi = new MediawikiApi('https://www.wikidata.org/w/api.php');
 		$this->entities = [];
 		$this->lang = $lang;
 		$this->cache = $cache;
@@ -57,21 +57,21 @@ 
 	 * @param CacheItemPoolInterface $cache The cache to use.
 	 * @return Item
 	 */
-	public static function factory( $id, $lang, CacheItemPoolInterface $cache ) {
-		$item = new Item( $id, $lang, $cache );
-		foreach ( $item->getPropertyOfTypeItem( self::PROP_INSTANCE_OF ) as $instanceOf ) {
+	public static function factory($id, $lang, CacheItemPoolInterface $cache) {
+		$item = new Item($id, $lang, $cache);
+		foreach ($item->getPropertyOfTypeItem(self::PROP_INSTANCE_OF) as $instanceOf) {
 			// Try to find a class matching the registered 'instance of'.
-			foreach ( static::$registeredClasses as $classId => $className ) {
+			foreach (static::$registeredClasses as $classId => $className) {
 				// If this 'instance of' is registered, use it.
-				if ( $classId === $instanceOf->getItem()->getId() ) {
+				if ($classId === $instanceOf->getItem()->getId()) {
 					// This won't re-request the metadata, because that's cached.
-					return new $className( $id, $lang, $cache );
+					return new $className($id, $lang, $cache);
 				}
 			}
 		}
 
 		// If we're here, just leave it as a basic Item.
-		$item->setCache( $cache );
+		$item->setCache($cache);
 		return $item;
 	}
 
@@ -81,19 +81,19 @@ 
 	 * @throws Exception if called on Item or the registering class does not have INSTANCE_OF set.
 	 */
 	public static function register() {
-		if ( static::class === self::class ) {
-			throw new Exception( __METHOD__ . ' should only be called on subclasses of Item' );
+		if (static::class === self::class) {
+			throw new Exception(__METHOD__ . ' should only be called on subclasses of Item');
 		}
-		if ( !static::INSTANCE_OF ) {
-			throw new Exception( 'Please set INSTANCE_OF for ' . static::class );
+		if (!static::INSTANCE_OF) {
+			throw new Exception('Please set INSTANCE_OF for ' . static::class);
 		}
-		static::$registeredClasses[ static::INSTANCE_OF ] = static::class;
+		static::$registeredClasses[static::INSTANCE_OF] = static::class;
 	}
 
 	/**
 	 * @param CacheItemPoolInterface $cache The cache to use.
 	 */
-	public function setCache( CacheItemPoolInterface $cache ) {
+	public function setCache(CacheItemPoolInterface $cache) {
 		$this->cache = $cache;
 	}
 
@@ -102,8 +102,8 @@ 
 	 * @return string|bool The ID or false if it couldn't be determined.
 	 */
 	public function getId() {
-		$entity = $this->getEntity( $this->id );
-		return isset( $entity['id'] ) ? $entity['id'] : false;
+		$entity = $this->getEntity($this->id);
+		return isset($entity['id']) ? $entity['id'] : false;
 	}
 
 	/**
@@ -111,10 +111,10 @@ 
 	 * @return string
 	 */
 	public function getLabel() {
-		$entity = $this->getEntity( $this->id );
-		if ( ! empty( $entity['labels'][ $this->lang ]['value'] ) ) {
+		$entity = $this->getEntity($this->id);
+		if (!empty($entity['labels'][$this->lang]['value'])) {
 			// Use the label if there is one.
-			return $entity['labels'][ $this->lang ]['value'];
+			return $entity['labels'][$this->lang]['value'];
 		}
 		// Or just use the ID.
 		return $entity['id'];
@@ -124,7 +124,7 @@ 
 	 * @return string The Wikidata.org URL for this item.
 	 */
 	public function getWikidataUrl() {
-		return $this->wikidataUrlBase.$this->id;
+		return $this->wikidataUrlBase . $this->id;
 	}
 
 	/**
@@ -139,32 +139,32 @@ 
 	 * @param string $type
 	 * @return array
 	 */
-	public function getStandardProperties( $wikiProject = 'WikiProject_Books', $type = 'work' ) {
-		if ( $type !== 'work' ) {
+	public function getStandardProperties($wikiProject = 'WikiProject_Books', $type = 'work') {
+		if ($type !== 'work') {
 			$type = 'edition';
 		}
 		$cacheKey = $type . '_item_property_IDs';
-		if ( $this->cache->hasItem( $cacheKey ) ) {
-			$propIds = $this->cache->getItem( $cacheKey )->get();
+		if ($this->cache->hasItem($cacheKey)) {
+			$propIds = $this->cache->getItem($cacheKey)->get();
 		} else {
 			$domCrawler = new Crawler();
 			$wikiProjectUrl = 'https://www.wikidata.org/wiki/Wikidata:' . $wikiProject;
-			$domCrawler->addHtmlContent( file_get_contents( $wikiProjectUrl ) );
-			$propAncors = "//h3/span[@id='" . ucfirst( $type ) . "_item_properties']/../following-sibling::table[1]//td[2]/a";
-			$propCells = $domCrawler->filterXPath( $propAncors );
+			$domCrawler->addHtmlContent(file_get_contents($wikiProjectUrl));
+			$propAncors = "//h3/span[@id='" . ucfirst($type) . "_item_properties']/../following-sibling::table[1]//td[2]/a";
+			$propCells = $domCrawler->filterXPath($propAncors);
 			$propIds = [];
-			$propCells->each( function ( Crawler $node, $i ) use ( &$propIds ) {
+			$propCells->each(function(Crawler $node, $i) use (&$propIds) {
 				$propId = $node->text();
 				$propIds[] = $propId;
 			} );
-			$cacheItem = $this->cache->getItem( $cacheKey )
-				->expiresAfter( new DateInterval( 'PT1H' ) )
-				->set( $propIds );
-			$this->cache->save( $cacheItem );
+			$cacheItem = $this->cache->getItem($cacheKey)
+				->expiresAfter(new DateInterval('PT1H'))
+				->set($propIds);
+			$this->cache->save($cacheItem);
 		}
 		$workProperties = [];
-		foreach ( $propIds as $propId ) {
-			$workProperties[] = self::factory( $propId, $this->lang, $this->cache );
+		foreach ($propIds as $propId) {
+			$workProperties[] = self::factory($propId, $this->lang, $this->cache);
 		}
 
 		return $workProperties;
@@ -174,17 +174,17 @@ 
 	 * @param string $propertyId
 	 * @return bool|Time[]
 	 */
-	public function getPropertyOfTypeTime( $propertyId ) {
+	public function getPropertyOfTypeTime($propertyId) {
 		$times = [];
 		$entity = $this->getEntity();
-		if ( !isset( $entity['claims'][$propertyId] ) ) {
+		if (!isset($entity['claims'][$propertyId])) {
 			// No statements for this property.
 			return $times;
 		}
 		// print_r($entity['claims'][$propertyId]);exit();
-		foreach ( $entity['claims'][$propertyId] as $claim ) {
+		foreach ($entity['claims'][$propertyId] as $claim) {
 			// print_r($claim);
-			$times[] = new Time( $claim, $this->lang, $this->cache );
+			$times[] = new Time($claim, $this->lang, $this->cache);
 //
 // $timeValue = $claim['datavalue']['value']['time'];
 // // Ugly workaround for imprecise dates. :-(
@@ -206,28 +206,28 @@ 
 	 *
 	 * @return \Samwilson\SimpleWikidata\Properties\Item[]
 	 */
-	public function getPropertyOfTypeItem( $propertyId ) {
-		$entity = $this->getEntity( $this->id );
-		if ( !isset( $entity['claims'][$propertyId] ) ) {
+	public function getPropertyOfTypeItem($propertyId) {
+		$entity = $this->getEntity($this->id);
+		if (!isset($entity['claims'][$propertyId])) {
 			return [];
 		}
 		$items = [];
-		foreach ( $entity['claims'][$propertyId] as $claim ) {
-			$items[] = new Properties\Item( $claim, $this->lang, $this->cache );
+		foreach ($entity['claims'][$propertyId] as $claim) {
+			$items[] = new Properties\Item($claim, $this->lang, $this->cache);
 		}
 
 		return $items;
 	}
 
-	public function setPropertyOfTypeItem( $property, $itemId ) {
-		$itemIdNumeric = substr( $itemId, 1 );
+	public function setPropertyOfTypeItem($property, $itemId) {
+		$itemIdNumeric = substr($itemId, 1);
 
 		// First see if this property already exists, and that it is different from what's being set.
-		$entity = $this->getEntity( $this->id );
-		if ( !empty( $entity['claims'][$property] ) ) {
+		$entity = $this->getEntity($this->id);
+		if (!empty($entity['claims'][$property])) {
 			// Get the first claim, and update it if necessary.
-			$claim = array_shift( $entity['claims'][$property] );
-			if ( $claim['mainsnak']['datavalue']['value']['id'] == $itemId ) {
+			$claim = array_shift($entity['claims'][$property]);
+			if ($claim['mainsnak']['datavalue']['value']['id'] == $itemId) {
 				// Already is the required value, no need to change.
 				return;
 			}
@@ -235,56 +235,56 @@ 
 			$claim['mainsnak']['datavalue']['value']['numeric-id'] = $itemIdNumeric;
 			$apiParams = [
 				'action' => 'wbsetclaim',
-				'claim' => json_encode( $claim ),
+				'claim' => json_encode($claim),
 			];
 		}
 
 		// If no claim was found (and modified) above, create a new claim.
-		if ( !isset( $apiParams ) ) {
+		if (!isset($apiParams)) {
 			$apiParams = [
 				'action' => 'wbcreateclaim',
 				'entity' => $this->getId(),
 				'property' => $property,
 				'snaktype' => 'value',
-				'value' => json_encode( [ 'entity-type' => 'item', 'numeric-id' => $itemIdNumeric ] ),
+				'value' => json_encode(['entity-type' => 'item', 'numeric-id' => $itemIdNumeric]),
 			];
 		}
 
 		// @TODO Save the property.
 
 		// Clear the cache.
-		$this->cache->deleteItem( $this->getEntityCacheKey( $this->id ) );
+		$this->cache->deleteItem($this->getEntityCacheKey($this->id));
 	}
 
-	public function getPropertyOfTypeUrl( $entityId, $propertyId ) {
-		$entity = $this->getEntity( $entityId );
-		if ( !isset( $entity['claims'][$propertyId] ) ) {
+	public function getPropertyOfTypeUrl($entityId, $propertyId) {
+		$entity = $this->getEntity($entityId);
+		if (!isset($entity['claims'][$propertyId])) {
 			return false;
 		}
 		$urls = [];
-		foreach ( $entity['claims'][$propertyId] as $claim ) {
+		foreach ($entity['claims'][$propertyId] as $claim) {
 			$urls[] = $claim['mainsnak']['datavalue']['value'];
 		}
 
 		return $urls;
 	}
 
-	public function getPropertyOfTypeExternalIdentifier( $entityId, $propertyId ) {
-		$entity = $this->getEntity( $entityId );
-		if ( !isset( $entity['claims'][$propertyId] ) ) {
+	public function getPropertyOfTypeExternalIdentifier($entityId, $propertyId) {
+		$entity = $this->getEntity($entityId);
+		if (!isset($entity['claims'][$propertyId])) {
 			return false;
 		}
 		$idents = [];
-		foreach ( $entity['claims'][$propertyId] as $claim ) {
+		foreach ($entity['claims'][$propertyId] as $claim) {
 			$qualifiers = [];
-			if ( !isset( $claim['qualifiers'] ) ) {
+			if (!isset($claim['qualifiers'])) {
 				continue;
 			}
-			foreach ( $claim['qualifiers'] as $qualsInfo ) {
-				foreach ( $qualsInfo as $qualInfo ) {
-					$qualProp = self::factory( $qualInfo['property'], $this->lang, $this->cache );
+			foreach ($claim['qualifiers'] as $qualsInfo) {
+				foreach ($qualsInfo as $qualInfo) {
+					$qualProp = self::factory($qualInfo['property'], $this->lang, $this->cache);
 					$propLabel = $qualProp->getLabel();
-					if ( !isset( $qualifiers[$propLabel] ) ) {
+					if (!isset($qualifiers[$propLabel])) {
 						$qualifiers[$propLabel] = [];
 					}
 					$qualifiers[$propLabel][] = $qualInfo['datavalue']['value'];
@@ -304,17 +304,17 @@ 
 	 * @param string $property One of the PROP_* constants.
 	 * @return string|bool The value, or false if it can't be found.
 	 */
-	public function getPropertyOfTypeText( $property ) {
-		$entity = $this->getEntity( $this->id );
-		if ( isset( $entity['claims'][$property] ) ) {
+	public function getPropertyOfTypeText($property) {
+		$entity = $this->getEntity($this->id);
+		if (isset($entity['claims'][$property])) {
 			// Use the first title.
-			foreach ( $entity['claims'][$property] as $t ) {
-				if ( !isset( $t['mainsnak']['datavalue']['value']['language'] ) ) {
-					var_dump( $t['mainsnak']['datavalue']['value'] );
+			foreach ($entity['claims'][$property] as $t) {
+				if (!isset($t['mainsnak']['datavalue']['value']['language'])) {
+					var_dump($t['mainsnak']['datavalue']['value']);
 					exit();
 				}
-				if ( $t['mainsnak']['datavalue']['value']['language'] == $this->lang
-					&& !empty( $t['mainsnak']['datavalue']['value']['text'] )
+				if ($t['mainsnak']['datavalue']['value']['language'] == $this->lang
+					&& !empty($t['mainsnak']['datavalue']['value']['text'])
 				) {
 					return $t['mainsnak']['datavalue']['value']['text'];
 				}
@@ -332,16 +332,16 @@ 
 	 * @param $property
 	 * @return mixed[]|bool If it's not false it's an array with 'amount', 'unit', etc.
 	 */
-	public function getPropertyOfTypeQuantity( $property ) {
+	public function getPropertyOfTypeQuantity($property) {
 		$quantities = [];
-		$entity = $this->getEntity( $this->id );
-		if ( !isset( $entity['claims'][$property] ) ) {
+		$entity = $this->getEntity($this->id);
+		if (!isset($entity['claims'][$property])) {
 			return false;
 		}
-		foreach ( $entity['claims'][$property] as $t ) {
+		foreach ($entity['claims'][$property] as $t) {
 			$quantity = $t['mainsnak']['datavalue']['value'];
-			$unitId = substr( $quantity['unit'], strlen( $this->wikidataUrlBase ) + 1 );
-			$quantity['unit'] = self::factory( $unitId, $this->lang, $this->cache );
+			$unitId = substr($quantity['unit'], strlen($this->wikidataUrlBase) + 1);
+			$quantity['unit'] = self::factory($unitId, $this->lang, $this->cache);
 			$quantities[] = $quantity;
 		}
 		return $quantities;
@@ -352,19 +352,19 @@ 
 	 * @param string $property One of the PROP_* constants.
 	 * @param string $value The value.
 	 */
-	public function setPropertyOfTypeText( $property, $value ) {
+	public function setPropertyOfTypeText($property, $value) {
 		// First see if this property already exists, and that it is different from what's being set.
-		$entity = $this->getEntity( $this->id );
-		if ( !empty( $entity['claims'][$property] ) ) {
+		$entity = $this->getEntity($this->id);
+		if (!empty($entity['claims'][$property])) {
 			// Find this language's claim (if there is one).
-			foreach ( $entity['claims'][$property] as $claim ) {
-				if ( $claim['mainsnak']['datavalue']['value']['language'] == $this->lang ) {
+			foreach ($entity['claims'][$property] as $claim) {
+				if ($claim['mainsnak']['datavalue']['value']['language'] == $this->lang) {
 					// Modify this claim's text value.
 					$titleClaim = $claim;
 					$titleClaim['mainsnak']['datavalue']['value']['text'] = $value;
 					$setTitleParams = [
 						'action' => 'wbsetclaim',
-						'claim' => \GuzzleHttp\json_encode( $titleClaim ),
+						'claim' => \GuzzleHttp\json_encode($titleClaim),
 					];
 					continue;
 				}
@@ -372,22 +372,22 @@ 
 		}
 
 		// If no claim was found (and modified) above, create a new claim.
-		if ( !isset( $setTitleParams ) ) {
+		if (!isset($setTitleParams)) {
 			$setTitleParams = [
 				'action' => 'wbcreateclaim',
 				'entity' => $this->getId(),
 				'property' => $property,
 				'snaktype' => 'value',
-				'value' => \GuzzleHttp\json_encode( [ 'text' => $value, 'language' => $this->lang ] ),
+				'value' => \GuzzleHttp\json_encode(['text' => $value, 'language' => $this->lang]),
 			];
 		}
 
 		// Save the property.
 		$wdWpOauth = new WdWpOauth();
-		$wdWpOauth->makeCall( $setTitleParams, true );
+		$wdWpOauth->makeCall($setTitleParams, true);
 
 		// Clear the cache.
-		$this->cache->deleteItem( $this->getEntityCacheKey( $this->id ) );
+		$this->cache->deleteItem($this->getEntityCacheKey($this->id));
 	}
 
 	/**
@@ -400,31 +400,31 @@ 
 
 	public function getWikipediaIntro() {
 		$cacheKey = 'wikipedia-intro-' . $this->id . $this->lang;
-		if ( $this->cache->hasItem( $cacheKey ) ) {
-			return $this->cache->getItem( $cacheKey )->get();
+		if ($this->cache->hasItem($cacheKey)) {
+			return $this->cache->getItem($cacheKey)->get();
 		}
-		$entity = $this->getEntity( $this->id );
-		if ( !isset( $entity['sitelinks'] ) ) {
+		$entity = $this->getEntity($this->id);
+		if (!isset($entity['sitelinks'])) {
 			return [];
 		}
-		foreach ( $entity['sitelinks'] as $sitelink ) {
-			if ( $sitelink['site'] == $this->lang . 'wiki' ) {
-				$api = new MediawikiApi( 'https://' . $this->lang . '.wikipedia.org/w/api.php' );
-				$req = new SimpleRequest( 'query', [
+		foreach ($entity['sitelinks'] as $sitelink) {
+			if ($sitelink['site'] == $this->lang . 'wiki') {
+				$api = new MediawikiApi('https://' . $this->lang . '.wikipedia.org/w/api.php');
+				$req = new SimpleRequest('query', [
 					'prop' => 'extracts',
 					'exintro' => true,
 					'titles' => $sitelink['title'],
-				] );
-				$response = $api->getRequest( $req );
-				$page = array_shift( $response['query']['pages'] );
+				]);
+				$response = $api->getRequest($req);
+				$page = array_shift($response['query']['pages']);
 				$out = [
 					'title' => $page['title'],
 					'html' => $page['extract'],
 				];
-				$cacheItem = $this->cache->getItem( $cacheKey )
-					->expiresAfter( new DateInterval( 'P1D' ) )
-					->set( $out );
-				$this->cache->save( $cacheItem );
+				$cacheItem = $this->cache->getItem($cacheKey)
+					->expiresAfter(new DateInterval('P1D'))
+					->set($out);
+				$this->cache->save($cacheItem);
 
 				return $out;
 			}
@@ -439,22 +439,22 @@ 
 	 * @param bool $ignoreCache
 	 * @return array|bool
 	 */
-	public function getEntity( $id = null, $ignoreCache = false ) {
+	public function getEntity($id = null, $ignoreCache = false) {
 		$idActual = $id ?: $this->id;
-		$cacheKey = $this->getEntityCacheKey( $idActual );
-		if ( !$ignoreCache && $this->cache->hasItem( $cacheKey ) ) {
-			return $this->cache->getItem( $cacheKey )->get();
+		$cacheKey = $this->getEntityCacheKey($idActual);
+		if (!$ignoreCache && $this->cache->hasItem($cacheKey)) {
+			return $this->cache->getItem($cacheKey)->get();
 		}
-		$metadataRequest = new SimpleRequest( 'wbgetentities', [ 'ids' => $idActual ] );
-		$itemResult = $this->wdApi->getRequest( $metadataRequest );
-		if ( !isset( $itemResult['success'] ) || !isset( $itemResult['entities'][$id] ) ) {
+		$metadataRequest = new SimpleRequest('wbgetentities', ['ids' => $idActual]);
+		$itemResult = $this->wdApi->getRequest($metadataRequest);
+		if (!isset($itemResult['success']) || !isset($itemResult['entities'][$id])) {
 			return false;
 		}
 		$metadata = $itemResult['entities'][$idActual];
-		$cacheItem = $this->cache->getItem( $cacheKey )
-			->expiresAfter( new DateInterval( 'PT10M' ) )
-			->set( $metadata );
-		$this->cache->save( $cacheItem );
+		$cacheItem = $this->cache->getItem($cacheKey)
+			->expiresAfter(new DateInterval('PT10M'))
+			->set($metadata);
+		$this->cache->save($cacheItem);
 		return $metadata;
 	}
 
@@ -463,7 +463,7 @@ 
 	 *
 	 * @return string
 	 */
-	protected function getEntityCacheKey( $id ) {
+	protected function getEntityCacheKey($id) {
 		return 'entities' . $id;
 	}
 }