Netzmacht\Workflow\Flow\Base

Complexity

Total Complexity

13

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getLabel()	0	4	1
A	setLabel()	0	6	1
A	getName()	0	4	1
A	setConfigValue()	0	6	1
A	getConfigValue()	0	8	2
A	hasConfigValue()	0	4	1
A	addConfig()	0	8	2
A	removeConfigValue()	0	6	1
A	getConfig()	0	4	1

<?php

/**
 * Workflow library.
 *
 * @package    workflow
 * @author     David Molineus <david.molineus@netzmacht.de>
 * @copyright  2014-2017 netzmacht David Molineus
 * @license    LGPL 3.0 https://github.com/netzmacht/workflow
 * @filesource
 */

declare(strict_types=1);

namespace Netzmacht\Workflow\Flow;

/**
 * Class Configurable is the base class for each flow elements.
 *
 * @package Netzmacht\Workflow\Flow
 */
abstract class Base
{
    /**
     * Configuration values.
     *
     * @var array
     */
    private $config = array();

    /**
     * Name of the element.
     *
     * @var string
     */
    private $name;

    /**
     * Label of the element.
     *
     * @var string
     */
    private $label;

    /**
     * Construct.
     *
     * @param string $name   Name of the element.
     * @param string $label  Label of the element.
     * @param array  $config Configuration values.
     */
    public function __construct(string $name, string $label = '', array $config = array())
    {
        $this->name   = $name;
        $this->label  = $label ?: $name;
        $this->config = $config;
    }

    /**
     * Get element label.
     *
     * @return string
     */
    public function getLabel(): string
    {
        return $this->label;
    }

    /**
     * Set the label.
     *
     * @param string $label The label.
     *
     * @return $this
     */
    public function setLabel(string $label): self
    {
        $this->label = $label;

        return $this;
    }

    /**
     * Get element name.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Set a config value.
     *
     * @param string $name  Config property name.
     * @param mixed  $value Config property value.
     *
     * @return $this
     */
    public function setConfigValue(string $name, $value): self
    {
        $this->config[$name] = $value;

        return $this;
    }

    /**
     * Get a config value.
     *
     * @param string $name    Config property name.
     * @param mixed  $default Default value which is returned if config is not set.
     *
     * @return mixed
     */
    public function getConfigValue(string $name, $default = null)
    {
        if (isset($this->config[$name])) {
            return $this->config[$name];
        }

        return $default;
    }

    /**
     * Consider if config value isset.
     *
     * @param string $name Name of the config value.
     *
     * @return bool
     */
    public function hasConfigValue(string $name): bool
    {
        return isset($this->config[$name]);
    }

    /**
     * Add multiple config properties.
     *
     * @param array $values Config values.
     *
     * @return $this
     */
    public function addConfig(array $values): self
    {
        foreach ($values as $name => $value) {
            $this->setConfigValue($name, $value);
        }

        return $this;
    }

    /**
     * Remove a config property.
     *
     * @param string $name Config property name.
     *
     * @return $this
     */
    public function removeConfigValue(string $name): self
    {
        unset($this->config[$name]);

        return $this;
    }

    /**
     * Get configuration.
     *
     * @return array
     */
    public function getConfig(): array
    {
        return $this->config;
    }
}