Matecat\SimpleS3\Commands\Handlers\DeleteFolder

Complexity

Total Complexity

7

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

86.36%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	29	5
A	validateParams()	0	5	2

<?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 Exception;
use Matecat\SimpleS3\Commands\CommandHandler;
use Matecat\SimpleS3\Helpers\File;

class DeleteFolder extends CommandHandler
{
    /**
     * Delete a folder.
     * For a complete reference:
     * https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html
     *
     * @param array $params
     *
     * @return true
     * @throws Exception
     */
    public function handle(array $params = []): true

The type Matecat\SimpleS3\Commands\Handlers\true was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        $bucketName = $params[ 'bucket' ];
        $prefix     = $params[ 'prefix' ];

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

        try {
            $this->client->getConn()->deleteMatchingObjects($bucketName, $prefix);
            $this->commandHandlerLogger?->log($this, sprintf('Folder \'%s\' was successfully deleted from \'%s\' bucket', $prefix, $bucketName));

            if ($this->client->hasCache()) {
                $items = $this->client->getItemsInABucket([
                        'bucket' => $bucketName,
                        'prefix' => $prefix,
                ]);

                foreach ($items as $key) {
                    $this->client->getCache()->remove($bucketName, $key);
                }
            }

            return true;

The expression return true returns the type true which is incompatible with the type-hinted return Matecat\SimpleS3\Commands\Handlers\true.

        } catch (Exception $e) {
            $this->commandHandlerLogger?->logExceptionAndReturnFalse($e);

            throw $e;
        }
    }

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