Matecat\SimpleS3\Commands\Handlers\HasFolder

Complexity

Total Complexity

10

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

86.21%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	18	5
A	validateParams()	0	5	2
A	returnItemFromS3()	0	18	3

<?php
/**
 *  This file is part of the Simple S3 package.
 *
 * (c) Mauro Cassani<https://github.com/mauretto78>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 */

namespace Matecat\SimpleS3\Commands\Handlers;

use Aws\S3\Exception\S3Exception;
use Exception;
use Matecat\SimpleS3\Commands\CommandHandler;
use Matecat\SimpleS3\Helpers\File;

class HasFolder extends CommandHandler
{
    /**
     * Check if a folder already exists.
     * For a complete reference:
     * https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html
     *
     * @param array $params
     *
     * @return bool
     * @throws Exception
     */
    public function handle(array $params = []): bool
    {
        $bucketName = $params[ 'bucket' ];
        $prefix     = $params[ 'prefix' ];

        if ($this->client->hasEncoder()) {
            $prefix = $this->client->getEncoder()->encode($prefix);
        }

        if (false === File::endsWith($prefix, $this->client->getPrefixSeparator())) {
            $prefix .= $this->client->getPrefixSeparator();
        }

        if ($this->client->hasCache() and $this->client->getCache()->has($bucketName, $prefix)) {
            return true;
        }

        return $this->returnItemFromS3($bucketName, $prefix);
    }

    /**
     * @param array $params
     *
     * @return bool
     */
    public function validateParams(array $params = []): bool
    {
        return (
                isset($params[ 'bucket' ]) and
                isset($params[ 'prefix' ])
        );
    }

    /**
     * @param string $bucketName
     * @param string $prefix
     *
     * @return bool
     * @throws Exception
     */
    private function returnItemFromS3(string $bucketName, string $prefix): bool
    {
        $command = $this->client->getConn()->getCommand(
                'listObjects',
                [
                        'Bucket' => $bucketName,
                        'Prefix' => $prefix,
                        'MaxKeys' => 1,
                ]
        );
        try {
            $result = $this->client->getConn()->execute($command);

            return $result[ 'Contents' ] || $result[ 'CommonPrefixes' ];
        } catch (S3Exception $e) {
            $this->commandHandlerLogger?->logExceptionAndReturnFalse($e);

            throw $e;
        }
    }
}