Sebastian Meyer
7 years ago
9 changed files with 360 additions and 86 deletions
@ -0,0 +1,170 @@
|
||||
<?php |
||||
/*************************************************************** |
||||
* Copyright notice |
||||
* |
||||
* (c) 2016 Kitodo. Key to digital objects e.V. <contact@kitodo.org> |
||||
* All rights reserved |
||||
* |
||||
* This script is part of the TYPO3 project. The TYPO3 project is |
||||
* free software; you can redistribute it and/or modify |
||||
* it under the terms of the GNU General Public License as published by |
||||
* the Free Software Foundation; either version 2 of the License, or |
||||
* (at your option) any later version. |
||||
* |
||||
* The GNU General Public License can be found at |
||||
* http://www.gnu.org/copyleft/gpl.html. |
||||
* |
||||
* This script is distributed in the hope that it will be useful, |
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
* GNU General Public License for more details. |
||||
* |
||||
* This copyright notice MUST APPEAR in all copies of the script! |
||||
***************************************************************/ |
||||
|
||||
/** |
||||
* [CLASS/FUNCTION INDEX of SCRIPT] |
||||
*/ |
||||
|
||||
/** |
||||
* Plugin 'DLF: Audioplayer' for the 'dlf' extension. |
||||
* |
||||
* @author Sebastian Meyer <sebastian.meyer@slub-dresden.de> |
||||
* @package TYPO3 |
||||
* @subpackage tx_dlf |
||||
* @access public |
||||
*/ |
||||
class tx_dlf_audioplayer extends tx_dlf_plugin { |
||||
|
||||
public $scriptRelPath = 'plugins/audioplayer/class.tx_dlf_audioplayer.php'; |
||||
|
||||
/** |
||||
* Holds the current audio file's URL and MIME type |
||||
* |
||||
* @var array |
||||
* @access protected |
||||
*/ |
||||
protected $audio = array (); |
||||
|
||||
/** |
||||
* Adds Player javascript |
||||
* |
||||
* @access protected |
||||
* |
||||
* @return string Player script tags ready for output |
||||
*/ |
||||
protected function addPlayerJS() { |
||||
|
||||
$output = array (); |
||||
|
||||
// $this->audio holds an array with URL and MIME type of the audio file. |
||||
// $this->audio = array ('url' => URL, 'mimetype' => MIME type) |
||||
|
||||
return implode("\n", $output); |
||||
|
||||
} |
||||
|
||||
/** |
||||
* Get audio's URL and MIME type |
||||
* |
||||
* @access protected |
||||
* |
||||
* @param integer $page: Page number |
||||
* |
||||
* @return array URL and MIME type of audio file |
||||
*/ |
||||
protected function getAudio($page) { |
||||
|
||||
// Get audio link. |
||||
if (!empty($this->doc->physicalPagesInfo[$this->doc->physicalPages[$page]]['files'][$this->conf['fileGrpAudio']])) { |
||||
|
||||
$this->audio['url'] = $this->doc->getFileLocation($this->doc->physicalPagesInfo[$this->doc->physicalPages[$page]]['files'][$this->conf['fileGrpAudio']]); |
||||
|
||||
$this->audio['mimetype'] = $this->doc->getFileMimeType($this->doc->physicalPagesInfo[$this->doc->physicalPages[$page]]['files'][$this->conf['fileGrpAudio']]); |
||||
|
||||
break; |
||||
|
||||
} else { |
||||
|
||||
if (TYPO3_DLOG) { |
||||
|
||||
\TYPO3\CMS\Core\Utility\GeneralUtility::devLog('[tx_dlf_audioplayer->getAudio('.$page.')] File not found in fileGrp "'.$this->conf['fileGrpAudio'].'"', $this->extKey, SYSLOG_SEVERITY_WARNING); |
||||
|
||||
} |
||||
|
||||
} |
||||
|
||||
return $this->audio; |
||||
|
||||
} |
||||
|
||||
/** |
||||
* The main method of the PlugIn |
||||
* |
||||
* @access public |
||||
* |
||||
* @param string $content: The PlugIn content |
||||
* @param array $conf: The PlugIn configuration |
||||
* |
||||
* @return string The content that is displayed on the website |
||||
*/ |
||||
public function main($content, $conf) { |
||||
|
||||
$this->init($conf); |
||||
|
||||
// Load current document. |
||||
$this->loadDocument(); |
||||
|
||||
if ($this->doc === NULL || $this->doc->numPages < 1) { |
||||
|
||||
// Quit without doing anything if required variables are not set. |
||||
return $content; |
||||
|
||||
} else { |
||||
|
||||
// Set default values if not set. |
||||
// page may be integer or string (physical page attribute) |
||||
if ( (int)$this->piVars['page'] > 0 || empty($this->piVars['page'])) { |
||||
|
||||
$this->piVars['page'] = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange((int)$this->piVars['page'], 1, $this->doc->numPages, 1); |
||||
|
||||
} else { |
||||
|
||||
$this->piVars['page'] = array_search($this->piVars['page'], $this->doc->physicalPages); |
||||
|
||||
} |
||||
|
||||
$this->piVars['double'] = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange($this->piVars['double'], 0, 1, 0); |
||||
|
||||
} |
||||
|
||||
// Load template file. |
||||
if (!empty($this->conf['templateFile'])) { |
||||
|
||||
$this->template = $this->cObj->getSubpart($this->cObj->fileResource($this->conf['templateFile']), '###TEMPLATE###'); |
||||
|
||||
} else { |
||||
|
||||
$this->template = $this->cObj->getSubpart($this->cObj->fileResource('EXT:dlf/plugins/audioplayer/template.tmpl'), '###TEMPLATE###'); |
||||
|
||||
} |
||||
|
||||
// Get audio data. |
||||
$this->audio = $this->getAudio($this->piVars['page']); |
||||
|
||||
// Fill in the template markers. |
||||
$markerArray = array ( |
||||
'###PLAYER_JS###' => $this->addPlayerJS() |
||||
); |
||||
|
||||
$content .= $this->cObj->substituteMarkerArray($this->template, $markerArray); |
||||
|
||||
return $this->pi_wrapInBaseClass($content); |
||||
|
||||
} |
||||
|
||||
} |
||||
|
||||
if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/dlf/plugins/audioplayer/class.tx_dlf_audioplayer.php']) { |
||||
include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/dlf/plugins/audioplayer/class.tx_dlf_audioplayer.php']); |
||||
} |
||||
@ -0,0 +1,90 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> |
||||
<!-- |
||||
Copyright notice |
||||
|
||||
(c) 2016 Kitodo. Key to digital objects e.V. <contact@kitodo.org> |
||||
All rights reserved |
||||
|
||||
This script is part of the TYPO3 project. The TYPO3 project is |
||||
free software; you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation; either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
The GNU General Public License can be found at |
||||
http://www.gnu.org/copyleft/gpl.html. |
||||
|
||||
This script is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
This copyright notice MUST APPEAR in all copies of the script! |
||||
--> |
||||
<T3DataStructure> |
||||
<meta> |
||||
<langDisable>1</langDisable> |
||||
</meta> |
||||
<sheets> |
||||
<sDEF> |
||||
<ROOT> |
||||
<TCEforms> |
||||
<sheetTitle>LLL:EXT:dlf/plugins/audioplayer/locallang.xml:tt_content.pi_flexform.sheet_general</sheetTitle> |
||||
</TCEforms> |
||||
<type>array</type> |
||||
<el> |
||||
<pages> |
||||
<TCEforms> |
||||
<exclude>1</exclude> |
||||
<label>LLL:EXT:lang/locallang_general.xml:LGL.startingpoint</label> |
||||
<config> |
||||
<type>group</type> |
||||
<internal_type>db</internal_type> |
||||
<allowed>pages</allowed> |
||||
<size>1</size> |
||||
<maxitems>1</maxitems> |
||||
<minitems>1</minitems> |
||||
</config> |
||||
</TCEforms> |
||||
</pages> |
||||
<excludeOther> |
||||
<TCEforms> |
||||
<exclude>1</exclude> |
||||
<label>LLL:EXT:dlf/plugins/audioplayer/locallang.xml:tt_content.pi_flexform.excludeOther</label> |
||||
<config> |
||||
<type>check</type> |
||||
<default>1</default> |
||||
</config> |
||||
</TCEforms> |
||||
</excludeOther> |
||||
<elementId> |
||||
<TCEforms> |
||||
<exclude>1</exclude> |
||||
<label>LLL:EXT:dlf/plugins/audioplayer/locallang.xml:tt_content.pi_flexform.elementId</label> |
||||
<config> |
||||
<type>input</type> |
||||
<eval>required,alphanum_x,nospace</eval> |
||||
<default>tx-dlf-audio</default> |
||||
</config> |
||||
</TCEforms> |
||||
</elementId> |
||||
<templateFile> |
||||
<TCEforms> |
||||
<exclude>1</exclude> |
||||
<label>LLL:EXT:dlf/plugins/audioplayer/locallang.xml:tt_content.pi_flexform.templateFile</label> |
||||
<config> |
||||
<type>group</type> |
||||
<internal_type>file_reference</internal_type> |
||||
<allowed>tmpl,tpl,html,htm,txt</allowed> |
||||
<size>1</size> |
||||
<maxitems>1</maxitems> |
||||
<minitems>0</minitems> |
||||
<disable_controls>upload</disable_controls> |
||||
</config> |
||||
</TCEforms> |
||||
</templateFile> |
||||
</el> |
||||
</ROOT> |
||||
</sDEF> |
||||
</sheets> |
||||
</T3DataStructure> |
||||
@ -0,0 +1,43 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> |
||||
<!-- |
||||
Copyright notice |
||||
|
||||
(c) 2016 Kitodo. Key to digital objects e.V. <contact@kitodo.org> |
||||
All rights reserved |
||||
|
||||
This script is part of the TYPO3 project. The TYPO3 project is |
||||
free software; you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation; either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
The GNU General Public License can be found at |
||||
http://www.gnu.org/copyleft/gpl.html. |
||||
|
||||
This script is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
This copyright notice MUST APPEAR in all copies of the script! |
||||
--> |
||||
<T3locallang> |
||||
<meta type="array"> |
||||
<type>module</type> |
||||
<description>Language labels for plugin tx_dlf_audioplayer</description> |
||||
</meta> |
||||
<data type="array"> |
||||
<languageKey index="default" type="array"> |
||||
<label index="tt_content.pi_flexform.sheet_general">Options</label> |
||||
<label index="tt_content.pi_flexform.excludeOther">Show only documents from the selected page</label> |
||||
<label index="tt_content.pi_flexform.elementId">@ID value of the HTML element for the audio player</label> |
||||
<label index="tt_content.pi_flexform.templateFile">Template file</label> |
||||
</languageKey> |
||||
<languageKey index="de" type="array"> |
||||
<label index="tt_content.pi_flexform.sheet_general">Einstellungen</label> |
||||
<label index="tt_content.pi_flexform.excludeOther">Nur Dokumente der ausgewählten Seite anzeigen</label> |
||||
<label index="tt_content.pi_flexform.elementId">@ID-Wert des HTML-Elements für den Audioplayer</label> |
||||
<label index="tt_content.pi_flexform.templateFile">HTML-Template</label> |
||||
</languageKey> |
||||
</data> |
||||
</T3locallang> |
||||
@ -0,0 +1,26 @@
|
||||
<!-- |
||||
Copyright notice |
||||
|
||||
(c) 2016 Kitodo. Key to digital objects e.V. <contact@kitodo.org> |
||||
All rights reserved |
||||
|
||||
This script is part of the TYPO3 project. The TYPO3 project is |
||||
free software; you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation; either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
The GNU General Public License can be found at |
||||
http://www.gnu.org/copyleft/gpl.html. |
||||
|
||||
This script is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
This copyright notice MUST APPEAR in all copies of the script! |
||||
--> |
||||
<!-- ###TEMPLATE### --> |
||||
<div id="tx-dlf-audio" class="tx-dlf-audio"></div> |
||||
###PLAYER_JS### |
||||
<!-- ###TEMPLATE### --> |
||||
Loading…
Reference in new issue