Element.php 2.65 KB
<?php

namespace Robo\Collection;

use Robo\Contract\TaskInterface;
use Robo\Contract\WrappedTaskInterface;
use Robo\Contract\ProgressIndicatorAwareInterface;

/**
 * One element in a collection.  Each element consists of a task
 * all of its before tasks, and all of its after tasks.
 *
 * This class is internal to Collection; it should not be used directly.
 */
class Element
{
    /**
     * @var \Robo\Contract\TaskInterface
     */
    protected $task;

    /**
     * @var \Robo\Contract\TaskInterface[]|callable[]
     */
    protected $before = [];

    /**
     * @var \Robo\Contract\TaskInterface[]|callable[]
     */
    protected $after = [];

    public function __construct(TaskInterface $task)
    {
        $this->task = $task;
    }

    /**
     * @param \Robo\Contract\TaskInterface|callable $before
     * @param string $name
     */
    public function before($before, $name)
    {
        if ($name) {
            $this->before[$name] = $before;
        } else {
            $this->before[] = $before;
        }
    }

    /**
     * @param \Robo\Contract\TaskInterface|callable $after
     * @param string $name
     */
    public function after($after, $name)
    {
        if ($name) {
            $this->after[$name] = $after;
        } else {
            $this->after[] = $after;
        }
    }

    /**
     * @return \Robo\Contract\TaskInterface[]|callable[]
     */
    public function getBefore()
    {
        return $this->before;
    }

    /**
     * @return \Robo\Contract\TaskInterface[]|callable[]
     */
    public function getAfter()
    {
        return $this->after;
    }

    /**
     * @return \Robo\Contract\TaskInterface
     */
    public function getTask()
    {
        return $this->task;
    }

    /**
     * @return \Robo\Contract\TaskInterface[]|callable[]
     */
    public function getTaskList()
    {
        return array_merge($this->getBefore(), [$this->getTask()], $this->getAfter());
    }

    /**
     * @return int
     */
    public function progressIndicatorSteps()
    {
        $steps = 0;
        foreach ($this->getTaskList() as $task) {
            if ($task instanceof WrappedTaskInterface) {
                $task = $task->original();
            }
            // If the task is a ProgressIndicatorAwareInterface, then it
            // will advance the progress indicator a number of times.
            if ($task instanceof ProgressIndicatorAwareInterface) {
                $steps += $task->progressIndicatorSteps();
            }
            // We also advance the progress indicator once regardless
            // of whether it is progress-indicator aware or not.
            $steps++;
        }
        return $steps;
    }
}