SemanticMediaWiki / SemanticCite

src/DataValues/CitationReferenceValue.php

<?php

namespace SCI\DataValues;

use SCI\CitationReferencePositionJournal;
use SMW\DataValues\StringValue;

The type SMW\DataValues\StringValue 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 Html;

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

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class CitationReferenceValue extends StringValue {

	/**
	 * @var integer
	 */
	private $captionFormat;

	/**
	 * @var CitationReferencePositionJournal
	 */
	private $citationReferencePositionJournal;

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

	/**
	 * To display something like [[CiteRef::Foo, 1970|:50-52]] as [1]:50-52 for
	 * SCI_CITEREF_NUM
	 *
	 * @var boolean
	 */
	private $usesShortFormCaption = false;

	/**
	 * @param string $typeid
	 */
	public function __construct( $typeid = '' ) {
		parent::__construct( '_sci_ref' );

		// Currently there is no good way to inject the setting
		$this->captionFormat = $GLOBALS['scigCitationReferenceCaptionFormat'];
	}

	/**
	 * @since 1.0
	 *
	 * @param  integer $captionFormat
	 */
	public function setCaptionFormat( $captionFormat ) {
		$this->captionFormat = $captionFormat;
	}

	/**
	 * @see StringValue::parseUserValue
	 */
	protected function parseUserValue( $value ) {

		if ( method_exists( $this, 'getCallable' ) ) {
			$citationReferencePositionJournal = $this->getCallable( 'sci.citationreferencepositionjournal' );
			$this->citationReferencePositionJournal = $citationReferencePositionJournal();
		} else {
			$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );
		}

		$value = trim( $value );

		if ( $value === '' ) {
			$this->addError( wfMessage( 'sci-datavalue-empty-reference' )->inContentLanguage()->text() );

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

			$this->m_dataitem = new DIBlob( 'ERROR' );

The property m_dataitem does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

			return;
		}

		if ( $this->m_contextPage === null ) {
			parent::parseUserValue( $value );
			return;
		}

		$this->reference = $value;

		if ( $this->m_caption && $this->captionFormat === SCI_CITEREF_NUM ) {
			$this->usesShortFormCaption = true;
		}

		if ( !$this->m_caption ) {
			$this->m_caption = $this->reference;

The property m_caption does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		}

		// This is where the magic happens, compute the position of
		// a reference relative to previous CiteRef annotations
		$this->citationReferencePositionJournal->addJournalEntryFor(
			$this->m_contextPage,
			$this->reference
		);

		parent::parseUserValue( $this->reference );
	}

	/**
	 * @see StringValue::parseUserValue
	 */
	public function getShortWikiText( $linked = null ) {

		if ( $this->citationReferencePositionJournal === null ) {
			if ( method_exists( $this, 'getCallable' ) ) {
				$citationReferencePositionJournal = $this->getCallable( 'sci.citationreferencepositionjournal' );
				$this->citationReferencePositionJournal = $citationReferencePositionJournal();
			} else {
				$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );
			}
		}

		// We want the last entry here to get the major/minor
		// number that was internally recorded
		$referencePosition = $this->citationReferencePositionJournal->findLastReferencePositionEntryFor(
			$this->m_contextPage,
			$this->reference
		);

		if ( $referencePosition === null || $this->m_caption === false ) {
			return '';
		}

		$referenceHash = md5( $this->reference );

		if ( $this->captionFormat === SCI_CITEREF_NUM ) {
			list( $major, $minor ) = explode( '-', $referencePosition );
			$caption = $major;
			$captionClass = 'number';

			// [[CiteRef::Foo, 1970|:50-52]] will add the caption to the outside
			$shortFormCaption = $this->usesShortFormCaption ? $this->m_caption : '';
		} else {
			$captionClass = 'key';
			$caption = $this->m_caption;
			$shortFormCaption = ''; // Never has a short form
		}

		if ( $shortFormCaption !== '' ) {
			$shortFormCaption = Html::rawElement(
				'span',
				[ 'class' => 'scite-citeref-shortcaption' ],
				$shortFormCaption
			);
		}

		// Build element with back and forth link anchor
		$html = Html::rawElement(
			'span',
			[
				'id'    => 'scite-ref-'. $referenceHash . '-' . $referencePosition,
				'class' => 'scite-citeref-' . $captionClass,
				'data-reference' => $this->reference
			],
			'[[' .'#scite-' . $referenceHash . '|' . $caption . ']]'
		) . $shortFormCaption;

		return $html;
	}

}