Particle\Filter\FilterRule\Defaults

Complexity

Total Complexity

3

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	filter()	0	4	2

<?php
/**
 * Particle.
 *
 * @link      http://github.com/particle-php for the canonical source repository
 * @copyright Copyright (c) 2005-2015 Particle (http://particle-php.com)
 * @license   https://github.com/particle-php/Filter/blob/master/LICENSE New BSD License
 */
namespace Particle\Filter\FilterRule;

use Particle\Filter\FilterRule;

/**
 * Class Defaults
 *
 * @package Particle\Filter\FilterRule
 */
class Defaults extends FilterRule
{
    /**
     * Allows a default value to be set if no data key was provided
     *
     * @var bool
     */
    protected $allowNotSet = true;

    /**
     * @var mixed
     */
    protected $defaultValue;

    /**
     * @param mixed $defaultValue
     */
    public function __construct($defaultValue)
    {
        $this->defaultValue = $defaultValue;
    }

    /**
     * Return a default value if no value was provided
     *
     * @param mixed $value
     * @return string
     */
    public function filter($value)
    {
        return $value === null ? $this->defaultValue : $value;
    }
}