tx_crawler_view_process_list

Complexity

Total Complexity

36

Size/Duplication

Total Lines	387
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	asMinutes()	0	3	1
A	getPageId()	0	3	1
A	asDate()	0	6	2
A	render()	0	9	1
A	setActiveProcessCount()	0	3	1
A	getIconPath()	0	3	1
A	getRefreshLink()	0	6	1
A	setProcessCollection()	0	3	1
A	getIsCrawlerEnabled()	0	3	1
A	getMaxActiveProcessCount()	0	3	1
A	setPageId()	0	3	1
A	getMode()	0	3	1
A	setMaxActiveProcessCount()	0	3	1
A	setMode()	0	3	1
A	getAddLink()	0	10	3
A	setIconPath()	0	3	1
A	getTotalItemCount()	0	3	1
A	getActiveProcessCount()	0	3	1
A	getTotalUnprocessedItemCount()	0	3	1
A	setAssignedUnprocessedItemCount()	0	3	1
A	setTotalUnprocessedItemCount()	0	3	1
A	getCliPath()	0	3	1
A	setTotalItemCount()	0	3	1
A	getLLLabel()	0	3	1
A	getAssignedUnprocessedItemCount()	0	3	1
A	setIsCrawlerEnabled()	0	3	1
A	setCliPath()	0	3	1
A	getProcessCollection()	0	3	1
A	getEnableDisableLink()	0	15	2
A	getModeLink()	0	13	3

<?php

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2017 AOE GmbH <dev@aoe.com>
 *
 *  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 3 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 tx_crawler_view_process_list
 */
class tx_crawler_view_process_list
{

    /**
     * @var string template path
     */
    protected $template = 'EXT:crawler/template/process/list.php';

    /**
     * @var string icon path
     */
    protected $iconPath;

    /**
     * @var string Holds the path to start a cli process via command line
     */
    protected $cliPath;

    /**
     * @var int Holds the total number of items pending in the queue to be processed
     */
    protected $totalItemCount;

    /**
     * @var boolean Holds the enable state of the crawler
     */
    protected $isCrawlerEnabled;

    /**
     * @var int Holds the number of active processes
     */
    protected $activeProcessCount;

    /**
     * @var int Holds the number of maximum active processes
     */
    protected $maxActiveProcessCount;

    /**
     * @var string Holds the mode state, can be simple or detail
     */
    protected $mode;

    /**
     * @var int Holds the current page id
     */
    protected $pageId;

    /**
     * @var int $totalItemCount number of total item
     */
    protected $totalUnprocessedItemCount;

    /**
     * @var int Holds the number of assigned unprocessed items
     */
    protected $assignedUnprocessedItemCount;

    /**
     * @return int
     */
    public function getAssignedUnprocessedItemCount()
    {
        return $this->assignedUnprocessedItemCount;
    }

    /**
     * @return int
     */
    public function getTotalUnprocessedItemCount()
    {
        return $this->totalUnprocessedItemCount;
    }

    /**
     * @param int $assignedUnprocessedItemCount
     */
    public function setAssignedUnprocessedItemCount($assignedUnprocessedItemCount)
    {
        $this->assignedUnprocessedItemCount = $assignedUnprocessedItemCount;
    }

    /**
     * @param int $totalUnprocessedItemCount
     */
    public function setTotalUnprocessedItemCount($totalUnprocessedItemCount)
    {
        $this->totalUnprocessedItemCount = $totalUnprocessedItemCount;
    }

    /**
     * Set the page id
     *
     * @param int $pageId page id
     */
    public function setPageId($pageId)
    {
        $this->pageId = $pageId;
    }

    /**
     * Get the page id
     *
     * @return int page id
     */
    public function getPageId()
    {
        return $this->pageId;
    }

    /**
     * @return string
     */
    public function getMode()
    {
        return $this->mode;
    }

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

    /**
     * @return int
     */
    public function getMaxActiveProcessCount()
    {
        return $this->maxActiveProcessCount;
    }

    /**
     * @param int $maxActiveProcessCount
     */
    public function setMaxActiveProcessCount($maxActiveProcessCount)
    {
        $this->maxActiveProcessCount = $maxActiveProcessCount;
    }

    /**
     * @return int
     */
    public function getActiveProcessCount()
    {
        return $this->activeProcessCount;
    }

    /**
     * @param int $activeProcessCount
     */
    public function setActiveProcessCount($activeProcessCount)
    {
        $this->activeProcessCount = $activeProcessCount;
    }

    /**
     * @return boolean
     */
    public function getIsCrawlerEnabled()
    {
        return $this->isCrawlerEnabled;
    }

    /**
     * @param boolean $isCrawlerEnabled
     */
    public function setIsCrawlerEnabled($isCrawlerEnabled)
    {
        $this->isCrawlerEnabled = $isCrawlerEnabled;
    }

    /**
     * Returns the path to start a cli process from the shell
     *
     * @return string
     */
    public function getCliPath()
    {
        return $this->cliPath;
    }

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

    /**
     * @return int
     */
    public function getTotalItemCount()
    {
        return $this->totalItemCount;
    }

    /**
     * @param int $totalItemCount
     */
    public function setTotalItemCount($totalItemCount)
    {
        $this->totalItemCount = $totalItemCount;
    }

    /**
     * Method to set the path to the icon from outside
     *
     * @param string $iconPath
     */
    public function setIconPath($iconPath)
    {
        $this->iconPath = $iconPath;
    }

    /**
     * Method to read the configured icon path
     *
     * @return string
     */
    protected function getIconPath()
    {
        return $this->iconPath;
    }

    /**
     * Method to set a collection of process objects to be displayed in
     * the list view.
     *
     * @param tx_crawler_domain_process_collection $processCollection
     */
    public function setProcessCollection($processCollection)
    {
        $this->processCollection = $processCollection;

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

    }

    /**
     * Returns a collection of processObjects.
     *
     * @return tx_crawler_domain_process_collection
     */
    protected function getProcessCollection()
    {
        return $this->processCollection;
    }

    /**
     * Formats a timestamp as date
     *
     * @param int $timestamp
     *
     * @return string
     */
    protected function asDate($timestamp)
    {
        if ($timestamp > 0) {
            return date($this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:time.detailed'), $timestamp);

The expression return date($this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:time.detailed'), $timestamp) could also return false which is incompatible with the documented return type string. Did you maybe forget to handle an error condition?

        } else {
            return '';
        }
    }

    /**
     * Converts seconds into minutes
     *
     * @param int $seconds
     *
     * @return float
     */
    protected function asMinutes($seconds)
    {
        return round($seconds / 60);
    }

    /**
     * Returns a tag for the refresh icon
     *
     * @return string
     */
    protected function getRefreshLink()
    {
        return \AOE\Crawler\Utility\ButtonUtility::getLinkButton(
            'actions-refresh',
            $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.refresh'),
            'window.location=\'' . \TYPO3\CMS\Backend\Utility\BackendUtility::getModuleUrl('web_info') . '&SET[crawlaction]=multiprocess&id=' . $this->pageId . '\';'

The type TYPO3\CMS\Backend\Utility\BackendUtility was not found. Maybe you did not declare it correctly or list all dependencies?

        );
    }

    /**
     * Returns a link for the panel to enable or disable the crawler
     *
     * @return string
     */
    protected function getEnableDisableLink()
    {
        if ($this->getIsCrawlerEnabled()) {
            // TODO: Icon Should be bigger + Perhaps better icon
            return \AOE\Crawler\Utility\ButtonUtility::getLinkButton(
                'tx-crawler-stop',
                $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.disablecrawling'),
                'window.location+=\'&action=stopCrawling\';'
            );
        } else {
            // TODO: Icon Should be bigger
            return \AOE\Crawler\Utility\ButtonUtility::getLinkButton(
                'tx-crawler-start',
                $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.enablecrawling'),
                'window.location+=\'&action=resumeCrawling\';'
            );
        }
    }

    /**
     * Get mode link
     *
     * @param void
     *
     * @return string a-tag
     */
    protected function getModeLink()
    {
        if ($this->getMode() == 'detail') {
            return \AOE\Crawler\Utility\ButtonUtility::getLinkButton(
                'actions-document-view',
                $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.show.running'),
                'window.location+=\'&SET[processListMode]=simple\';'
            );
        } elseif ($this->getMode() == 'simple') {
            return \AOE\Crawler\Utility\ButtonUtility::getLinkButton(
                'actions-document-view',
                $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.show.all'),
                'window.location+=\'&SET[processListMode]=detail\';'
            );
        }
    }

    /**
     * Get add link
     *
     * @param void
     *
     * @return string a-tag
     */
    protected function getAddLink()
    {
        if ($this->getActiveProcessCount() < $this->getMaxActiveProcessCount() && $this->getIsCrawlerEnabled()) {
            return \AOE\Crawler\Utility\ButtonUtility::getLinkButton(
                'actions-add',
                $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.process.add'),
                'window.location+=\'&action=addProcess\';'
            );
        } else {
            return '';
        }
    }

    /**
     * Method to render the view.
     *
     * @return string html content
     */
    public function render()
    {
        ob_start();
        $this->template = \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName($this->template);

The type TYPO3\CMS\Core\Utility\GeneralUtility was not found. Maybe you did not declare it correctly or list all dependencies?

        include($this->template);
        $content = ob_get_contents();
        ob_end_clean();

        return $content;
    }

    /**
     * retrieve locallanglabel from environment
     * just a wrapper should be done in a cleaner way
     * later on
     *
     * @param string $label
     *
     * @return string
     */
    protected function getLLLabel($label)
    {
        return $GLOBALS['LANG']->sL($label);
    }
}