File "DownloadableCitationPlugin.inc.php"

Full path: /home/apeolorg/public_html/classes/plugins/DownloadableCitationPlugin.inc.php
File size: 1.23 B
MIME-type: text/x-php
Charset: utf-8

Download   Open   Edit   Advanced Editor &nnbsp; Back

<?php
/**
 * @file classes/plugins/DownloadableCitationPlugin.inc.php
 *
 * Copyright (c) 2014-2016 Simon Fraser University Library
 * Copyright (c) 2003-2016 John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @class CitationPlugin
 * @ingroup plugins
 *
 * @brief Abstract class for citation plugins
 */

import('classes.plugins.CitationPlugin');

abstract class DownloadableCitationPlugin extends CitationPlugin {

	/**
	 * Return an HTML-formatted citation. Default implementation displays
	 * an HTML-based citation using the citation.tpl template in the plugin
	 * path.
	 * @param $article Article
	 * @param $issue Issue
	 * @param $journal Journal
	 */
	function downloadCitation($article, $issue, $journal) {
		$output = parent::fetchCitation($article, $issue, $journal);
		$this->setHeaders($article, $issue, $journal);
		echo $output;
	}

	/**
	 * Set the headers for a downloadable citation.
	 *
	 * @param $article Article
	 * @param $issue Issue
	 * @param $journal Journal
	 */
	abstract function setHeaders($article, $issue, $journal);

	/**
	 * Whether this citation format is a downloadable file format (eg - EndNote)
	 *
	 * @return bool
	 */
	function isDownloadable() {
		return true;
	}
}

?>