tx_crawler_domain_process

Complexity

Total Complexity

16

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

5.41%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getActive()	0	4	1
A	getProcess_id()	0	4	1
A	getTimeForFirstItem()	0	7	1
A	getTimeForLastItem()	0	7	1
A	getRuntime()	0	4	1
A	getTTL()	0	4	1
A	countItemsProcessed()	0	5	1
A	countItemsToProcess()	0	5	1
A	getProgress()	0	10	2
A	countItemsAssigned()	0	4	1
B	getState()	0	12	5

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2009 AOE media (dev@aoemedia.de)
 *  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 tx_crawler_domain_process extends tx_crawler_domain_lib_abstract_dbobject
{

    /**
     * @var string table name
     */
    protected static $tableName = 'tx_crawler_process';

    /**
     * Returns the activity state for this process
     *
     * @param void
     * @return boolean
     */
    public function getActive()
    {
        return $this->row['active'];
    }

    /**
     * Returns the identifier for the process
     *
     * @return string
     */
    public function getProcess_id()
    {
        return $this->row['process_id'];
    }

    /**
     * Returns the timestamp of the exectime for the first relevant queue item.
     * This can be used to determine the runtime
     *
     * @return int
     */
    public function getTimeForFirstItem()
    {
        $queueRepository = new tx_crawler_domain_queue_repository();
        $entry = $queueRepository->findYoungestEntryForProcess($this);

        return $entry->getExecutionTime();
    }

    /**
     * Returns the timestamp of the exectime for the last relevant queue item.
     * This can be used to determine the runtime
     *
     * @return int
     */
    public function getTimeForLastItem()
    {
        $queueRepository = new tx_crawler_domain_queue_repository();
        $entry = $queueRepository->findOldestEntryForProcess($this);

        return $entry->getExecutionTime();
    }

    /**
     * Returns the difference between first and last processed item
     *
     * @return int
     */
    public function getRuntime()
    {
        return $this->getTimeForLastItem() - $this->getTimeForFirstItem();
    }

    /**
     * Returns the ttl of the process
     *
     * @return int
     */
    public function getTTL()
    {
        return $this->row['ttl'];
    }

    /**
     * Counts the number of items which need to be processed
     *
     * @param void
     * @return int
     */
    public function countItemsProcessed()
    {
        $queueRepository = new tx_crawler_domain_queue_repository();
        return $queueRepository->countExtecutedItemsByProcess($this);
    }

    /**
     * Counts the number of items which still need to be processed
     *
     * @param void
     * @return int
     */
    public function countItemsToProcess()
    {
        $queueRepository = new tx_crawler_domain_queue_repository();
        return $queueRepository->countNonExecutedItemsByProcess($this);
    }

    /**
     * Returns the Progress of a crawling process as a percentage value
     *
     * @param void
     * @return float
     */
    public function getProgress()
    {
        $all = $this->countItemsAssigned();
        if ($all > 0) {
            $res = round((100 / $all) * $this->countItemsProcessed());
        } else {
            $res = 0;
        }
        return $res;
    }

    /**
     * Returns the number of assigned Entrys
     *
     * @return int
     */
    public function countItemsAssigned()
    {
        return $this->row['assigned_items_count'];
    }

    /**
     * Return the processes current state
     *
     * @param void
     * @return string 'running'|'cancelled'|'completed'
     */
    public function getState()
    {
        // TODO: use class constants for these states
        if ($this->getActive() && $this->getProgress() < 100) {
            $stage = 'running';
        } elseif (!$this->getActive() && $this->getProgress() < 100) {
            $stage = 'cancelled';
        } else {
            $stage = 'completed';
        }
        return $stage;
    }
}