NextFlow\Arrays\Action\AbstractPopAction

Complexity

Total Complexity

4

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	execute()	0	16	3
	executePop()	0	1	?

<?php
/**
 * NextFlow (http://github.com/nextflow)
 *
 * @link http://github.com/nextflow/nextflow-php for the canonical source repository
 * @copyright Copyright (c) 2014-2016 NextFlow (http://github.com/nextflow)
 * @license https://raw.github.com/nextflow/nextflow-php/master/LICENSE MIT
 */

namespace NextFlow\Arrays\Action;

use InvalidArgumentException;
use NextFlow\Core\Action\AbstractAction;
use NextFlow\Core\Node\NodeInterface;

/**
 * A base final class for pop actions.
 */
abstract class AbstractPopAction extends AbstractAction
{
    /** The output action socket. */
    const SOCKET_OUTPUT = 'out';

    /** The array variable socket. */
    const SOCKET_ARRAY = 'array';

    /** The data variable socket. */
    const SOCKET_DATA = 'data';

    /**
     * Initializes a new instance of this class.
     */
    public function __construct()
    {
        parent::__construct();

        $this->createSocket(self::SOCKET_OUTPUT);
        $this->createSocket(self::SOCKET_ARRAY);
        $this->createSocket(self::SOCKET_DATA);
    }

    /**
     * Executes the node's logic.
     */
    public function execute()
    {
        $array = $this->getSocket(self::SOCKET_ARRAY)->getNode(0);
        if ($array === null) {
            throw new InvalidArgumentException('No array variable provided.');
        }

        $poppedValue = $this->executePop($array);

        $dataSocket = $this->getSocket(self::SOCKET_DATA);
        if ($dataSocket->hasNodes()) {
            $dataSocket->getNode(0)->setValue($poppedValue);
        }

        $this->activate(self::SOCKET_OUTPUT);
    }

    /**
     * Executes the pop logic.
     *
     * @param NodeInterface $node The node to pop data from.
     * @return mixed
     */
    abstract protected function executePop(NodeInterface $node);
}