phpbu\App\Backup\Sync\Clearable

Complexity

Total Complexity

10

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

59.09%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	setUpClearable()	0	17	5
A	cleanup()	0	12	3
A	simulateRemoteCleanup()	0	6	2

<?php
namespace phpbu\App\Backup\Sync;

use phpbu\App\Backup\Cleaner;
use phpbu\App\Backup\Target;
use phpbu\App\Configuration\Backup\Cleanup;
use phpbu\App\Factory;
use phpbu\App\Result;

/**
 * Clearable trait
 *
 * @package    phpbu
 * @subpackage Sync
 * @author     Sebastian Feldmann <sebastian@phpbu.de>
 * @author     Vitaly Baev <hello@vitalybaev.ru>
 * @copyright  Sebastian Feldmann <sebastian@phpbu.de>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 5.1.0
 */
trait Clearable
{
    /**
     * @var Cleaner
     */
    protected $cleanupConfig;

    /**
     * @var Cleaner
     */
    protected $cleaner;

    /**
     * Check sync clean configuration entities and set up a proper cleaner
     *
     * @param array $options
     * @throws \phpbu\App\Exception
     */
    public function setUpClearable(array $options)
    {
        $config = [];
        foreach ($options as $key => $value) {
            if (strpos($key, "cleanup.") === 0) {
                $config[str_replace('cleanup.', '', $key)] = $value;
            }
        }

        if (isset($config['type'])) {
            $skip = isset($config['skipOnFailure']) ? (bool) $config['skipOnFailure'] : true;
            // creating cleanup config
            $this->cleanupConfig = new Cleanup($config['type'], $skip, $config);

It seems like new \phpbu\App\Configuration\Backup\Cleanup($config['type'], $skip, $config) of type object<phpbu\App\Configuration\Backup\Cleanup> is incompatible with the declared type object<phpbu\App\Backup\Cleaner> of property $cleanupConfig.

            // creating cleaner
            $this->cleaner = (new Factory())->createCleaner($this->cleanupConfig->type, $this->cleanupConfig->options);
        }
    }

    /**
     * Execute the remote clean up if needed
     *
     * @param \phpbu\App\Backup\Target $target
     * @param \phpbu\App\Result        $result
     * @throws \phpbu\App\Exception
     */
    public function cleanup(Target $target, Result $result)
    {
        if (!$this->cleaner) {
            return;
        }

        if (!method_exists($this, 'createCollector')) {
            throw new \phpbu\App\Exception('"createCollector" method must be implemented in Sync class that uses Clearable');
        }
        $collector = $this->createCollector($target);

It seems like createCollector() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->cleaner->cleanup($target, $collector, $result);
    }

    /**
     * Simulate remote cleanup.
     *
     * @param Target $target
     * @param Result $result
     */
    public function simulateRemoteCleanup(Target $target, Result $result)
    {
        if ($this->cleaner) {
            $result->debug("  sync cleanup: {$this->cleanupConfig->type}" . PHP_EOL);
        }
    }
}