SemanticMediaWiki / SemanticCite

src/DataValues/ResourceIdentifierStringValueParser.php

<?php

namespace SCI\DataValues;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class ResourceIdentifierStringValueParser {

	/**
	 * @var string
	 */
	private $typeid;

	/**
	 * @param string $typeid
	 */
	public function __construct( $typeid ) {
		$this->typeid = $typeid;
	}

	/**
	 * @since 1.0
	 *
	 * @return true
	 */
	public function parse( &$value ) {

		// Remove a possible url-prefix

		if ( $this->typeid ===  '_sci_doi' ) {
			// Remove anything before 10 as in http://dx.doi.org/10.1000/123
			$value = substr( $value, strcspn( $value, '10' ) );
		} elseif ( strrpos( $value, '://' ) !== false ) {
			// Remove anything before the last / as in http://foo/bar123
			$value = substr( $value, strrpos( $value, '/' ) + 1 );
		}

		// Remove other possible prefixes

		// http://www.doi.org/doi_handbook/2_Numbering.html#2.4
		// All DOI names are converted to upper case upon registration
		// but since it system is case insensitive, we store it as lower
		// case as it "looks" better
		if ( $this->typeid ===  '_sci_doi' ) {
			$value = strtolower( $value );
		} else {
			$value = str_replace( [ 'VIAF', 'OCLC', 'PMID' ], '', strtoupper( $value ) );
		}

		return $this->canMatchValueToPattern( $value );

The expression return $this->canMatchValueToPattern($value) returns the type false|integer which is incompatible with the documented return type true.

	}

	/**
	 * @return string
	 */
	public function getCanonicalName() {

		switch ( $this->typeid ) {
			case '_sci_viaf':
				return 'VIAF';
			case '_sci_oclc':
				return 'OLCL';
			case '_sci_pmid':
				return 'PMID';
			case '_sci_pmcid':
				return 'PMCID';
			case '_sci_olid':
				return 'OLID';
			case '_sci_doi':
				return 'DOI';
		}

		return null;
	}

	/**
	 * @return string
	 */
	public function getResourceTargetUri() {

		switch ( $this->typeid ) {
			case '_sci_viaf':
	 			// http://www.oclc.org/research/activities/viaf.html
	 			// http://id.loc.gov/vocabulary/identifiers/viaf.html
				return "https://viaf.org/viaf/";
			case '_sci_oclc':
				// http://www.oclc.org/support/documentation/glossary/oclc.en.html#OCLCControlNumber
				return "https://www.worldcat.org/oclc/";
			case '_sci_pmcid':
				// https://www.nlm.nih.gov/pubs/techbull/nd09/nd09_pmc_urls.html
				return "https://www.ncbi.nlm.nih.gov/pmc/";
			case '_sci_pmid':
				return "https://www.ncbi.nlm.nih.gov/pubmed/";
			case '_sci_olid':
				return "https://openlibrary.org/books/";
			case '_sci_doi':
				// https://en.wikipedia.org/wiki/Digital_object_identifier
				return "https://doi.org/";
		}
	}

	private function canMatchValueToPattern( &$value ) {

		switch ( $this->typeid ) {
			case '_sci_viaf':
			case '_sci_oclc':
			case '_sci_pmid':
	 			return preg_match( "/^[0-9]*$/", $value );
			case '_sci_pmcid':
	 			return preg_match( "/PMC[\d]+/", $value );
			case '_sci_olid':
	 			return preg_match( "/OL[A-Z0-9]+/", $value );
			case '_sci_doi':
				// http://stackoverflow.com/questions/27910/finding-a-doi-in-a-document-or-page#
	 			return preg_match( "/\b(10[.][0-9]{4,}(?:[.][0-9]+)*\/(?:(?![\"&\'])\S)+)\b/", $value );
		}

		return false;
	}

}