kitodo / kitodo-publication

Classes/ViewHelpers/Link/PreviewViewHelper.php

<?php
namespace EWW\Dpf\ViewHelpers\Link;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;

class PreviewViewHelper extends AbstractViewHelper
{
    /**
     * @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $configurationManager;

    /**
     * @var \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $uriBuilder;

    /**
     * documentRepository
     *
     * @var \EWW\Dpf\Domain\Repository\DocumentRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $documentRepository;

    /**
     * Secret API key for delivering inactive documents.
     * @var string
     */
    private $secretKey;


    /**
     * escapeOutput, activates / deactivates HTML escaping.
     *
     * @var bool
     */
    protected $escapeOutput = false;


    /**
     * Initialize secret key from plugin TYPOScript configuration.
     */
    public function initialize() {
        parent::initialize();

        $settings = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FULL_TYPOSCRIPT);

        if (isset($settings['plugin.']['tx_dpf.']['settings.']['deliverInactiveSecretKey'])) {
            $this->secretKey = $settings['plugin.']['tx_dpf.']['settings.']['deliverInactiveSecretKey'];
        }
    }

    /**
     * Returns the View Icon with link
     *
     * @param array $row Data row
     * @param integer $viewPage Detail View page id
     * @param  integer $apiPid
     * @param  string $insideText
     * @param  string $class
     * @return string html output
     */
    protected function getViewIcon(array $row, $pageUid, $apiPid, $insideText, $class)
    {

       $previewMets = $this->uriBuilder
            ->reset()
            ->setTargetPageUid($apiPid)
            ->setArguments(array( 'tx_dpf' => $row))
            ->setCreateAbsoluteUri(true)
            ->setUseCacheHash(FALSE)
            //->setNoCache(TRUE)
            ->buildFrontendUri();

        $additionalGetVars = $this->uriBuilder
            ->reset()
            ->setTargetPageUid($pageUid)
            ->setUseCacheHash(TRUE)
            //->setNoCache(TRUE)
            ->setArguments(
                array( 'tx_dlf' => array(
                        'id' => urldecode($previewMets),
                    )
                )
            )
            ->setCreateAbsoluteUri(true)
            ->buildFrontendUri();

        $title = \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate('manager.tooltip.preview', 'dpf', $arguments = null);
        $icon = '<a href="'. $additionalGetVars . '" data-toggle="tooltip" class="' . $class . '" title="' . $title . '">' . $insideText . '</a>';

        return $icon;

    }

    public function initializeArguments()
    {
        parent::initializeArguments();

        $this->registerArgument('arguments', 'array', '', true);
        $this->registerArgument('pageUid', 'int', '', true);
        $this->registerArgument('apiPid', 'int', '', true);
        $this->registerArgument('class', 'string', '', true);
    }

    /**
     * Renders a record list as known from the TYPO3 list module
     * Note: This feature is experimental!
     *
     * @return string the rendered record list
     */
    public function render()
    {
        $arguments = $this->arguments['arguments'];
        $pageUid = $this->arguments['pageUid'];
        $apiPid = $this->arguments['apiPid'];
        $class = $this->arguments['class'];

        if ($arguments['document']) {

            // it's already a document object?
            if ($arguments['document'] instanceof \EWW\Dpf\Domain\Model\Document) {

                $document = $arguments['document'];

            } else if (MathUtility::canBeInterpretedAsInteger($arguments['document'])) {

                $document = $this->documentRepository->findByUid($arguments['document']);

            }

            // we found a valid document
            if ($document) {

The variable $document does not seem to be defined for all execution paths leading up to this point.

                $row['qid'] = $document->getUid();

$row was never initialized. Although not strictly required by PHP, it is generally a good practice to add $row = array(); before regardless.

                $row['action'] = 'preview';

            } else {

                // ok, nothing to render. So return empty content.
                return '';

            }

        } else if ($arguments['documentObjectIdentifier']) {

            $row['action'] = 'mets';

            $row['qid'] = $arguments['documentObjectIdentifier'];

            // pass configured API secret key parameter to enable dissemination of inactive documents
            if (isset($this->secretKey)) {
                $row['deliverInactive'] = $this->secretKey;
            }

        }

        $insideText = $this->renderChildren();

        $content = $this->getViewIcon($row, $pageUid, $apiPid, $insideText, $class);

The variable $row does not seem to be defined for all execution paths leading up to this point.

        return $content;

    }
}