phpbu\App\Backup\Collector

Complexity

Total Complexity

4

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	6	1
A	isFileMatch()	0	7	2
A	isFilenameMatch()	0	4	1
	getBackupFiles()	0	1	?

<?php
namespace phpbu\App\Backup;

use phpbu\App\Util;

/**
 * Collector class.
 *
 * @package    phpbu
 * @subpackage Backup
 * @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
 */
abstract class Collector
{
    /**
     * Backup target
     *
     * @var \phpbu\App\Backup\Target
     */
    protected $target;

    /**
     * Target filename regex
     *
     * @var string
     */
    protected $fileRegex;

    /**
     * Collection cache
     *
     * @var \phpbu\App\Backup\File[]
     */
    protected $files;

    /**
     * Setting up
     *
     * @param \phpbu\App\Backup\Target $target
     */
    public function setUp(Target $target)
    {
        $this->target    = $target;
        $this->fileRegex = Util\Path::datePlaceholdersToRegex($target->getFilenameRaw());
        $this->files     = [];
    }

    /**
     * Return true if target full path matches file and path regex.
     *
     * @param string $targetPath
     * @param string $rawPath
     * @return bool
     */
    protected function isFileMatch(string $targetPath, string $rawPath): bool
    {
        $pathRegex = Util\Path::datePlaceholdersToRegex($rawPath);
        $pathRegex .= $pathRegex ? '/' : '';
        $fileRegex = Util\Path::datePlaceholdersToRegex($this->target->getFilenameRaw());
        return preg_match('#'.$pathRegex . $fileRegex . '$#i', $targetPath);
    }

    /**
     * Returns true if filename matches the target regex
     *
     * @param string $filename
     * @return bool
     */
    protected function isFilenameMatch(string $filename): bool
    {
        return preg_match('#'.$this->fileRegex . '#i', $filename);
    }

    /**
     * Get all created backups.
     *
     * @return \phpbu\App\Backup\File[]
     */
    abstract public function getBackupFiles() : array;
}