netresearch / kite

src/Task.php

<?php
/**
 * See class comment
 *
 * PHP Version 5
 *
 * @category Netresearch
 * @package  Netresearch\Kite
 * @author   Christian Opitz <christian.opitz@netresearch.de>
 * @license  http://www.netresearch.de Netresearch Copyright
 * @link     http://www.netresearch.de
 */

namespace Netresearch\Kite;

/**
 * Base Task Class
 *
 * {@see configureVariables() for option information}
 *
 * @category Netresearch
 * @package  Netresearch\Kite
 * @author   Christian Opitz <christian.opitz@netresearch.de>
 * @license  http://www.netresearch.de Netresearch Copyright
 * @link     http://www.netresearch.de
 */
abstract class Task extends Variables
{
    /**
     * @var \Netresearch\Kite\Service\Console
     */
    public $console;

    /**
     * @var Job
     */
    protected $job;

    /**
     * Task constructor.
     *
     * @param Variables $parent Parent object (Task/Job/Workflow)
     */
    public function __construct(Variables $parent)
    {
        $this->job = $parent instanceof Job ? $parent : $parent->get('job');
        $this->console = $this->job->console;
        
        parent::__construct($parent);
    }

    /**
     * Configures the available options
     *
     * @return array
     */
    protected function configureVariables()
    {
        return array(
            'name' => array(
                'type' => 'string',
                'label' => 'Name of the task'
            ),
            'after' => array(
                'type' => 'string',
                'label' => 'Name of the task to execute this task after'
            ),
            'before' => array(
                'type' => 'string',
                'label' => 'Name of the task to execute this task before'
            ),
            'onBefore' => array(
                'type' => 'array',
                'label' => 'Array of sub tasks to execute prior to this task'
            ),
            'onAfter' => array(
                'type' => 'array',
                'label' => 'Array of sub tasks to execute after this task'
            ),
            'message' => array(
                'type' => 'string',
                'label' => 'Message to output when job is run with --dry-run or prior to execution'
            ),
            'if' => array(
                'type' => array('string', 'callback', 'bool'),
                'label' => 'Expression string, callback returning true or false or boolean. Depending of that the task will be executed or not'
            ),
            'executeInPreview' => array(
                'type' => 'bool',
                'default' => false,
                'label' => 'Whether to execute this task even when job is run with --dry-run'
            ),
            'force' => array(
                'type' => 'bool',
                'default' => false,
                'label' => 'Whether this task should be run even when prior tasks (inside the current workflow) failed, exited or broke execution.'
            ),
            'toVar' => array(
                'type' => 'string',
                'label' => 'The variable to save the return value of the execute method of the task to.'
            ),
        );
    }

    /**
     * Handle onBefore, onAfter and name
     *
     * @param mixed $offset The name of the variable
     * @param mixed $value  The value
     *
     * @return void
     */
    public function offsetSet($offset, $value)
    {
        if ($offset === 'onBefore' || $offset == 'onAfter') {
            $type = lcfirst(substr($offset, 2));
            $name = $this->offsetGet('name');
            $factory = $this->console->getFactory();
            foreach ((array) $this->expand($value) as $subTask) {
                $subTask = $factory->createTask($this->expand($subTask), $this, [$type => $name]);
                $this->job->addTask($subTask);
            }
        }
        if ($offset === 'name' && parent::offsetGet('name')) {

It seems like you call parent on a different method (offsetGet() instead of offsetSet()). Are you sure this is correct? If so, you might want to change this to $this->offsetGet().

            throw new Exception('name may not be set doubly (try putting it at top of the task/job/workflow configuration');
        }
        parent::offsetSet($offset, $value);
    }

    /**
     * Re-add the onBefore and onAfter tasks and regenerate name
     *
     * @return void
     */
    public function __clone()
    {
        parent::offsetSet('name', null);

It seems like you call parent on a different method (offsetSet() instead of __clone()). Are you sure this is correct? If so, you might want to change this to $this->offsetSet().

        parent::__clone();
        foreach (['onBefore', 'onAfter'] as $type) {
            if ($val = $this->offsetGet($type)) {
                $this->offsetSet($type, $val);
            }
        }
    }

    /**
     * Handle name
     *
     * @param mixed $offset The variable name
     *
     * @return bool
     */
    public function offsetExists($offset)
    {
        return $offset === 'name' || parent::offsetExists($offset);
    }

    /**
     * Generate name if it doesn't exist
     *
     * @param mixed $offset The name of the variable
     *
     * @return mixed
     */
    public function &offsetGet($offset)
    {
        if ($offset === 'name' && !parent::offsetGet('name')) {
            parent::offsetSet('name', spl_object_hash($this));

It seems like you call parent on a different method (offsetSet() instead of offsetGet()). Are you sure this is correct? If so, you might want to change this to $this->offsetSet().

        }
        return parent::offsetGet($offset);
    }

    /**
     * Called from parent task as soon as task is ready to run - which doesn't
     * necessarely mean that it'll be run.
     *
     * @return void
     */
    protected function initialize()
    {
    }

    /**
     * Shortcut to set()
     *
     * @param bool $flag The flag
     *
     * @return $this
     */
    public function executeInPreview($flag = true)
    {
        return $this->set(__FUNCTION__, $flag);
    }

    /**
     * Shortcut to set()
     *
     * @param string $var The variable name
     *
     * @return $this
     */
    public function toVar($var)
    {
        return $this->set(__FUNCTION__, $var);
    }

    /**
     * Shortcut to set()
     *
     * @param bool $flag The flag
     *
     * @return $this
     */
    public function force($flag = true)
    {
        return $this->set(__FUNCTION__, $flag);
    }

    /**
     * Shortcut to set()
     *
     * @param string $message The message
     *
     * @return $this
     */
    public function message($message)
    {
        return $this->set(__FUNCTION__, $message);
    }

    /**
     * Shortcut to set()
     *
     * @param string|callable|boolean $condition The condition
     *
     * @return $this
     */
    public function when($condition)
    {
        return $this->set('if', $condition);
    }

    /**
     * Run this task
     *
     * @throws Exception
     *
     * @return mixed
     */
    public function run()
    {
        $this->preview();
        if ($this->shouldExecute()) {
            return $this->execute();
        }
    }

    /**
     * Determines whether this task should be executed
     *
     * @return bool
     */
    protected function shouldExecute()
    {
        return !$this->job->isDryRun() || $this->get('executeInPreview');
    }

    /**
     * The preview for this task - this is called right before execution and
     * in preview mode
     *
     * @return void
     */
    public function preview()
    {
        $message = $this->get('message');
        if ($message) {
            $this->console->output($message);
        }
    }

    /**
     * Actually execute this task
     *
     * @return mixed
     */
    public function execute()
    {
        throw new Exception('Method not implemented');
    }
}
?>