Aura\Filter\AbstractStaticFilter

Complexity

Total Complexity

7

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setInstance()	0	8	2
A	validate()	0	13	2
A	sanitize()	0	14	2

<?php
/**
 *
 * This file is part of Aura for PHP.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 *
 */
namespace Aura\Filter;

/**
 *
 * A static proxy to a ValueFilter instance.
 *
 * @package Aura.Filter
 *
 */
abstract class AbstractStaticFilter
{
    /**
     *
     * The proxied filter instance.
     *
     * @var ValueFilter
     *
     */
    protected static $instance;

    /**
     *
     * Prevents construction of the static proxy as an instance.
     *
     * @codeCoverageIgnore
     *
     */
    private function __construct()
    {
    }

    /**
     *
     * Sets the proxied filter instance.
     *
     * @param ValueFilter $instance The proxied filter instance.
     *
     * @return null
     *
     */
    public static function setInstance(ValueFilter $instance)
    {
        if (static::$instance) {
            $class = get_called_class();
            throw new Exception("{$class}::\$instance is already set.");
        }
        static::$instance = $instance;
    }

    /**
     *
     * Validates a value using a rule.
     *
     * @param mixed $value The value to validate.
     *
     * @param string $rule The rule name.
     *
     * @param ...$args Arguments to pass to the rule.
     *
     * @return bool True on success, false on failure.
     *
     */
    public static function validate($value, $rule)

The parameter $value is not used and could be removed.

The parameter $rule is not used and could be removed.

    {
        if (! static::$instance) {
            $class = get_called_class();
            throw new Exception("{$class}::\$instance not set.");
        }

        $args = func_get_args();
        return call_user_func_array(
            array(static::$instance, 'validate'),
            $args
        );
    }

    /**
     *
     * Sanitizes a value in place using a rule.
     *
     * @param mixed $value The value to sanitize.
     *
     * @param string $rule The rule name.
     *
     * @param ...$args Arguments to pass to the rule.
     *
     * @return bool True on success, false on failure.
     *
     */
    public static function sanitize(&$value, $rule)

The parameter $rule is not used and could be removed.

    {
        if (! static::$instance) {
            $class = get_called_class();
            throw new Exception("{$class}::\$instance not set.");
        }

        $args = func_get_args();
        $args[0] = &$value;
        return call_user_func_array(
            array(static::$instance, 'sanitize'),
            $args
        );
    }
}