Wicked\Timely\Entities\Task

Complexity

Total Complexity

31

Size/Duplication

Total Lines	240
Duplicated Lines	6.67 %

Coupling/Cohesion

Components	3
Dependencies	3

Test Coverage

Coverage

44.83%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	3
A	getStartBooking()	0	4	1
A	getStartTime()	8	8	4
A	getComment()	0	4	1
A	isPushed()	8	8	4
A	getEndBooking()	0	4	1
A	getEndTime()	0	4	1
A	getIntermediateBookings()	0	4	1
A	getTicketId()	0	4	1
A	getDuration()	0	4	1
A	isClipped()	0	4	1
A	isOngoing()	0	4	1
A	isPaused()	0	13	5
B	calculateDuration()	0	24	6

<?php

/**
 * \Wicked\Timely\Entities\Task
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    wick-ed
 * @copyright 2020 Bernhard Wick
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/wick-ed/timely
 */

namespace Wicked\Timely\Entities;

/**
 * Task entity
 *
 * @author    wick-ed
 * @copyright 2020 Bernhard Wick
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/wick-ed/timely
 */
class Task
{

    /**
     * First booking of this task
     *
     * @var \Wicked\Timely\Entities\Booking $startBooking
     */
    protected $startBooking;

    /**
     * Last booking of this task
     *
     * @var \Wicked\Timely\Entities\Booking $endBooking
     */
    protected $endBooking;

    /**
     * Bookings within this task
     *
     * @var \Wicked\Timely\Entities\Booking[] $intermediateBookings
     */
    protected $intermediateBookings;

    /**
     * Intermediate tasks, done within this task instance
     *
     * @var \Wicked\Timely\Entities\Task[] $intermediateTasks
     */
    protected $intermediateTasks;

    /**
     * The task's duration
     *
     * @var integer $duration
     */
    protected $duration;

    /**
     * Whether or not the task is being clipped due to filtering
     *
     * @var boolean $isClipped
     */
    protected $isClipped = false;

    /**
     * Default constructor
     *
     * @param \Wicked\Timely\Entities\Booking   $startBooking         The first booking of the task
     * @param \Wicked\Timely\Entities\Booking   $endBooking           The last booking of the task
     * @param \Wicked\Timely\Entities\Booking[] $intermediateBookings Bookings within this task
     */
    public function __construct($startBooking, $endBooking, $intermediateBookings)
    {
        // set the properties
        $this->startBooking = $startBooking;
        $this->endBooking = $endBooking;
        $this->intermediateBookings = $intermediateBookings;
        // calculate the duration
        $this->duration = $this->calculateDuration($startBooking, $endBooking, $intermediateBookings);
        // determine if we are being clipped
        foreach ($intermediateBookings as $intermediateBooking) {
            if ($intermediateBooking instanceof Clipping) {
                $this->isClipped = true;
                break;
            }
        }
    }

    /**
     * Getter for the first booking of the task instance
     *
     * @return \Wicked\Timely\Entities\Booking
     */
    public function getStartBooking()
    {
        return $this->startBooking;
    }

    /**
     * Getter for the first booking of the task instance
     *
     * @return string
     */
    public function getStartTime()

This method seems to be duplicated in your project.

    {
        $firstIntermediate = reset($this->intermediateBookings);
        if ($this->isClipped() && $firstIntermediate instanceof Pause && $firstIntermediate->isPauseEnd()) {
            return $firstIntermediate->getTime();
        }
        return $this->getStartBooking()->getTime();
    }

    /**
     * Getter for the first booking of the task instance
     *
     * @return string
     */
    public function getComment()
    {
        return $this->getStartBooking()->getComment();
    }

    /**
     * Getter for the first booking of the task instance
     *
     * @return string
     */
    public function isPushed()

This method seems to be duplicated in your project.

    {
        $firstIntermediate = reset($this->intermediateBookings);
        if ($this->isClipped() && $firstIntermediate instanceof Pause && $firstIntermediate->isPauseEnd()) {
            return $firstIntermediate->isPushed();
        }
        return $this->getStartBooking()->isPushed();
    }

    /**
     * Getter for the last booking of the task instance
     *
     * @return \Wicked\Timely\Entities\Booking
     */
    public function getEndBooking()
    {
        return $this->endBooking;
    }

    /**
     * Getter for the first booking of the task instance
     *
     * @return string
     */
    public function getEndTime()
    {
        return $this->getEndBooking()->getTime();
    }

    /**
     * Getter for the intermediate bookings
     *
     * @return \Wicked\Timely\Entities\Booking[]
     */
    public function getIntermediateBookings()
    {
        return $this->intermediateBookings;
    }

    /**
     * Getter for the task's ticket id
     *
     * @return string
     */
    public function getTicketId()
    {
        return $this->getStartBooking()->getTicketId();
    }

    /**
     * Getter for the task duration
     *
     * @return integer
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * Getter for the task duration
     *
     * @return bool
     */
    protected function isClipped()
    {
        return $this->isClipped;
    }

    /**
     * Whether or not the task is still ongoing
     *
     * @return bool
     */
    public function isOngoing()
    {
        return ($this->getEndBooking()->getTicketId() === Clipping::CLIPPING_TAG_REAR);
    }

    /**
     * Whether or not the task is currently paused
     *
     * @return bool
     */
    public function isPaused()
    {
        // search for the first occurrence of a pause in the intermediate bookings
        foreach ($this->getIntermediateBookings() as $intermediateBooking) {
            if ($intermediateBooking instanceof Pause) {
                if ($intermediateBooking->getTicketId() === Pause::PAUSE_TAG_START) {
                    return true;
                } elseif ($intermediateBooking->getTicketId() === Pause::PAUSE_TAG_END) {
                    return false;
                }
            }
        }
    }

    /**
     * Calculates the duration of a task by given bookings
     *
     * @param \Wicked\Timely\Entities\Booking   $startBooking         The first booking of the task
     * @param \Wicked\Timely\Entities\Booking   $endBooking           The last booking of the task
     * @param \Wicked\Timely\Entities\Booking[] $intermediateBookings Bookings within this task
     *
     * @return integer
     */
    protected function calculateDuration($startBooking, $endBooking, array $intermediateBookings)
    {
        // get any potential clippings and include them as task borders
        foreach ($intermediateBookings as $intermediateBooking) {
            if ($intermediateBooking->canStartTask()) {
                $startBooking = $intermediateBooking;
            } elseif ($intermediateBooking->getTicketId() === Clipping::CLIPPING_TAG_REAR) {
                $endBooking = $intermediateBooking;
            }
        }

        // get the raw time without breaks and such
        $rawTime = strtotime($endBooking->getTime()) - strtotime($startBooking->getTime());

        // subtract the breaks
        if (count($intermediateBookings) > 1) {
            $this->intermediateTasks = TaskFactory::getTasksFromBookings(array_merge(array($endBooking), $intermediateBookings), false, true);
            foreach ($this->intermediateTasks as $intermediateTask) {
                $rawTime -= $intermediateTask->getDuration();
            }
        }
        // return what we got
        return $rawTime;
    }
}