SemanticMediaWiki / SemanticCite

src/CitationResourceMatchFinder.php

<?php

namespace SCI;

use SMW\Query\Language\SomeProperty;

The type SMW\Query\Language\SomeProperty was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\Query\Language\ValueDescription;

The type SMW\Query\Language\ValueDescription was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\Query\PrintRequest;

The type SMW\Query\PrintRequest was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\Store;

The type SMW\Store was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\DIProperty;

The type SMW\DIProperty was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\DataValues\PropertyValue;

The type SMW\DataValues\PropertyValue was not found. Maybe you did not declare it correctly or list all dependencies?

use SMWQuery as Query;

The type SMWQuery was not found. Maybe you did not declare it correctly or list all dependencies?

use SMWDIBlob as DIBlob;

The type SMWDIBlob was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\DataValueFactory;

The type SMW\DataValueFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use SMW\Query\QueryResult;

The type SMW\Query\QueryResult was not found. Maybe you did not declare it correctly or list all dependencies?

use SMWInfolink;

The type SMWInfolink was not found. Maybe you did not declare it correctly or list all dependencies?

use SCI\DataValues\ResourceIdentifierFactory;

/**
 * @license GNU GPL v2+
 * @since 2.2
 *
 * @author mwjames
 */
class CitationResourceMatchFinder {

	/**
	 * @var Store
	 */
	private $store;

	/**
	 * @var DataValueFactory
	 */
	private $dataValueFactory;

	/**
	 * @since 1.0
	 *
	 * @param Store $store
	 */
	public function __construct( Store $store ) {
		$this->store = $store;
		$this->dataValueFactory = DataValueFactory::getInstance();
	}

	/**
	 * @since 1.0
	 *
	 * @param array $subjects
	 * @param string $linkClass
	 *
	 * @return array
	 */
	public function findCitationResourceLinks( array $subjects, $linkClass = '', $caption = '' ) {

		$citationResourceLinks = [];

		foreach ( $subjects as $subject ) {

			$dataValue = $this->dataValueFactory->newDataItemValue(
				$subject,
				null
			);

			$browselink = SMWInfolink::newBrowsingLink(
				$caption,
				$dataValue->getWikiValue(),
				$linkClass
			);

			$citationResourceLinks[] = $browselink->getHTML();
		}

		return $citationResourceLinks;
	}

	/**
	 * Find match for [[OCLC::SomeOclcKey]]
	 *
	 * @since 1.0
	 *
	 * @param string $type
	 * @param string|null $id
	 *
	 * @return array
	 */
	public function findMatchForResourceIdentifierTypeToValue( $type, $id = null ) {

		if ( $id === null || $id === '' ) {
			return [];
		}

		$resourceIdentifierFactory = new ResourceIdentifierFactory();

		$resourceIdentifierStringValue = $resourceIdentifierFactory->newResourceIdentifierStringValueForType( $type );
		$resourceIdentifierStringValue->setUserValue( $id );
		$id = $resourceIdentifierStringValue->getWikiValue();

		$description = new SomeProperty(
			$resourceIdentifierStringValue->getProperty(),
			new ValueDescription( new DIBlob( $id ) )
		);

		$query = new Query(
			$description,
			false,
			false
		);

		$query->querymode = Query::MODE_INSTANCES;
		$query->setLimit( 10 );

		if ( defined( 'SMWQuery::NO_CACHE' ) ) {
			$query->setOption( Query::NO_CACHE, true );
		}

		if ( defined( 'SMWQuery::PROC_CONTEXT' ) ) {
			$query->setOption( Query::PROC_CONTEXT, 'SCI.CitationResourceMatchFinder' );
		}

		return $this->store->getQueryResult( $query )->getResults();
	}

	/**
	 * @since 1.0
	 *
	 * @param string $citationReference
	 *
	 * @return array
	 */
	public function findCitationTextFor( $citationReference ) {

		$text = '';
		$subjects = [];

		$queryResult = $this->findMatchForCitationReference(
			$citationReference
		);

		if ( !$queryResult instanceof QueryResult ) {
			return [ $subjects, $text ];
		}

		while ( $resultArray = $queryResult->getNext() ) {
			foreach ( $resultArray as $result ) {

				// Collect all subjects for the same reference because it can happen
				// that the same reference key is used for different citation
				// resources therefore only return one (the last) valid citation
				// text but return all subjects to make it easier to find them later
				$subjects[] = $result->getResultSubject();

				while ( ( $dataValue = $result->getNextDataValue() ) !== false ) {
					$text = $dataValue->getShortWikiText();
				}
			}
		}

		return [ $subjects, $text ];
	}

	/**
	 * Find match for [[Citation key::SomeKey]]|?Citation text
	 *
	 * @since 1.0
	 *
	 * @param string $citationReference
	 *
	 * @return QueryResult
	 */
	public function findMatchForCitationReference( $citationReference ) {

		$description = new SomeProperty(
			new DIProperty( PropertyRegistry::SCI_CITE_KEY ),
			new ValueDescription( new DIBlob( $citationReference ) )
		);

		$propertyValue = $this->dataValueFactory->newDataValueByType( '__pro' );
		$propertyValue->setDataItem(
			new DIProperty( PropertyRegistry::SCI_CITE_TEXT )
		);

		$description->addPrintRequest(
			new PrintRequest( PrintRequest::PRINT_PROP, null, $propertyValue )
		);

		$query = new Query(
			$description,
			false,
			false
		);

		$query->querymode = Query::MODE_INSTANCES;
		$query->setLimit( 10 );

		if ( defined( 'SMWQuery::PROC_CONTEXT' ) ) {
			$query->setOption( Query::PROC_CONTEXT, 'SCI.CitationResourceMatchFinder' );
		}

		return $this->store->getQueryResult( $query );
	}

}