Oliverde8\Component\RuleEngine\Rules\Constant

Complexity

Total Complexity

3

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	apply()	0	3	1
A	getRuleCode()	0	3	1
A	validate()	0	3	1

<?php

declare(strict_types=1);

namespace Oliverde8\Component\RuleEngine\Rules;

use Oliverde8\Component\RuleEngine\Exceptions\RuleException;

/**
 * Class Constant
 *
 * @author    de Cramer Oliver<oiverde8@gmail.com>
 * @copyright 2018 Oliverde8
 * @package Oliverde8\Component\RuleEngine\Rules
 */
class Constant extends AbstractRule
{

    /**
     * Apply a certain rule and returns the result.
     *
     * @param array $rowData Data that is being trasformed.
     * @param array $transformedData Transformed data at the current stage
     * @param array $options Options to be used by the rule.
     *
     * @return string|null
     */
    public function apply(array $rowData, array &$transformedData, array $options = [])
    {
        return $options['value'];
    }

    /**
     * @inheritdoc
     */
    public function validate($options): void
    {
        $this->requireOption('value', $options);
    }

    /**
     * Get unique code that needs to be used to apply this rule.
     *
     * @return string
     */
    public function getRuleCode(): string
    {
        return 'constant';
    }
}