Helldar\Support\Concerns\Deprecation

Complexity

Total Complexity

6

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	deprecatedClass()	0	9	1
A	deprecated()	0	3	1
A	getDeprecatedNamespace()	0	3	2
A	deprecatedMethod()	0	11	2

<?php
/*
 * This file is part of the "andrey-helldar/support" project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Andrey Helldar <helldar@ai-rus.com>
 *
 * @copyright 2021 Andrey Helldar
 *
 * @license MIT
 *
 * @see https://github.com/andrey-helldar/support
 */

namespace Helldar\Support\Concerns;

/**
 * If you use this trait, you need to install the dependency:.
 *
 * composer require symfony/deprecation-contracts
 */
trait Deprecation
{
    protected static $next_version = '5.0';

    protected static function deprecatedClass(string $new_class, string $old_class = null): void
    {
        $old_class = static::getDeprecatedNamespace($old_class);

        static::deprecated(
            'The %s class has been deprecated and will be removed in version %s, use %s instead.',
            $old_class,
            static::$next_version,
            $new_class
        );
    }

    protected static function deprecatedMethod(string $old_method, string $new_class, string $new_method = null): void
    {
        $namespace = static::getDeprecatedNamespace();

        static::deprecated(
            'The %s::%s() method has been deprecated and will be removed in version %s, use  %s::%s() instead.',
            $namespace,
            $old_method,
            static::$next_version,
            $new_class,
            $new_method ?: $old_method
        );
    }

    protected static function getDeprecatedNamespace(string $old_namespace = null): string
    {
        return $old_namespace ?: static::class;
    }

    protected static function deprecated(string $message, ...$args): void
    {
        trigger_deprecation('andrey-helldar/support', static::$next_version, $message, ...$args);
    }
}