phpbu\App\Backup\Collector\AmazonS3v3

Complexity

Total Complexity

11

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
C	getBackupFiles()	0	23	7
A	__construct()	0	7	1
A	getPrefix()	0	7	3

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

use Aws\S3\S3Client;
use phpbu\App\Backup\Collector;
use phpbu\App\Backup\File\AmazonS3v3 as AwsFile;
use phpbu\App\Backup\Path;
use phpbu\App\Backup\Target;
use phpbu\App\Util;

/**
 * AmazonS3v3 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
 */
class AmazonS3v3 extends Collector
{
    /**
     * @var \Aws\S3\S3Client
     */
    protected $client;

    /**
     * Amazon S3 bucket name
     *
     * @var string
     */
    protected $bucket;

    /**
     * Amazon S3 constructor.
     *
     * @param \phpbu\App\Backup\Target $target
     * @param S3Client                 $client
     * @param string                   $bucket
     * @param string                   $path
     * @param int                      $time
     */
    public function __construct(Target $target, S3Client $client, string $bucket, string $path, int $time)
    {
        $this->client = $client;
        $this->bucket = $bucket;
        $this->path   = new Path($path, $time, false, true);
        $this->setUp($target);
    }

    /**
     * Get all created backups.
     *
     * @return \phpbu\App\Backup\File[]
     */
    public function getBackupFiles() : array
    {
        $result = $this->client->listObjects([
            'Bucket'    => $this->bucket,
            'Prefix'    => $this->getPrefix($this->path->getPathThatIsNotChanging()),
        ]);

        if (!isset($result['Contents']) || !$result['Contents'] || !is_array($result['Contents'])) {
            return [];
        }

        foreach ($result['Contents'] as $object) {
            // skip currently created backup
            if ($object['Key'] == $this->getPrefix($this->path->getPath()) . $this->target->getFilename()) {
                continue;
            }
            if ($this->isFileMatch($object['Key'])) {
                $this->files[] = new AwsFile($this->client, $this->bucket, $object);
            }
        }

        return $this->files;
    }

    /**
     * Return prefix for querying remote files and folders
     *
     * @param string|null $path
     * @return string
     */
    protected function getPrefix($path = null): string
    {
        $path = $path ?: $this->path->getPathThatIsNotChanging();
        $prefix = Util\Path::withoutLeadingSlash($path);
        $prefix = $prefix ? Util\Path::withTrailingSlash($prefix) : '';
        return $prefix;
    }
}