matecat / simple-s3

src/Commands/Handlers/OpenItem.php

<?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 OpenItem extends CommandHandler
{
    /**
     * Open an item and return the content of it.
     *
     * @param array $params
     *
     * @return string|null
     * @throws Exception
     */
    public function handle(array $params = []): ?string
    {
        $bucketName = $params[ 'bucket' ];
        $keyName    = $params[ 'key' ];

        try {
            $url     = $this->client->getPublicItemLink(['bucket' => $bucketName, 'key' => $keyName]);
            $content = File::loadFile($url, $this->client->hasSslVerify());

            if (false === $content) {
                $this->commandHandlerLogger?->log($this, sprintf('Something went wrong during getting content of \'%s\' item from \'%s\' bucket', $keyName, $bucketName), 'warning');

                return null;
            }

            $this->commandHandlerLogger?->log($this, sprintf('Content from \'%s\' item was successfully obtained from \'%s\' bucket', $keyName, $bucketName));

            return $content;

The expression return $content could return the type true which is incompatible with the type-hinted return null|string. Consider adding an additional type-check to rule them out.

        } 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[ 'key' ])
        );
    }
}