ModelTrait::removeFile() - Code Metrics - Inspection of "Add ModelTrait" - sugeng-sulistiyawan/yii2-aws-s3 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 839ea2...8564cc )

by Sugeng

created 2023-04-03 14:57 UTC

ModelTrait::removeFile() A

↳ Parent: ModelTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	11
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	21
rs	9.9

<?php

namespace diecoding\aws\s3\traits;

use Yii;
use yii\web\UploadedFile;

/**
 * Trait ModelTrait for Model
 * 
 * @package diecoding\aws\s3\traits
 */
trait ModelTrait
{
    /**
     * @return \diecoding\aws\s3\Service
     */
    public function getS3Component()
    {
        return Yii::$app->get('s3');

    }

    /**
     * Save UploadedFile to AWS S3.
     * ! Important: This function uploads this model filename to keep consistency of the model.
     * 
     * @param UploadedFile $file Uploaded file to save
     * @param string $attribute Attribute name where the uploaded filename name will be saved
     * @param string $fileName Name which file will be saved. If empty will use the name from $file
     * @param bool $updateExtension `true` to automatically append the extension to the file name. Default is `true`
     * 
     * @return string|false Uploaded full path of filename on success or `false` in failure.
     */
    public function saveUploadedFile(UploadedFile $file, $attribute, $fileName = '', $updateExtension = true)
    {
        if ($this->hasError && !$file instanceof UploadedFile) {

            return false;
        }

        if (empty($fileName)) {
            $fileName = $file->name;
        }
        if ($updateExtension) {
            $fileName .= '.' . $file->extension;
        }

        $filePath = $this->getAttributePath($attribute) . $fileName;

        /** @var \Aws\ResultInterface $result */
        $result = $this->getS3Component()
            ->commands()
            ->upload(
                $filePath,
                $file->tempName
            )
            ->withContentType($file->type)
            ->execute();

        // Validate successful upload to S3
        if ($this->isSuccessResponseStatus($result)) {
            $this->{$attribute} = $fileName;

            return $fileName;
        }

        return false;
    }

    /**
     * Delete model file attribute from AWS S3.
     * 
     * @param string $attribute Attribute name which holds the filename
     * 
     * @return bool `true` on success or if file doesn't exist.
     */
    public function removeFile($attribute)
    {
        if (empty($this->{$attribute})) {
            // No file to remove
            return true;
        }

        $filePath = $this->getAttributePath($attribute) . $this->{$attribute};
        $result = $this->getS3Component()
            ->commands()
            ->delete($filePath)
            ->execute();

        // Validate successful removal from S3
        if ($this->isSuccessResponseStatus($result)) {
        if ($this->isSuccessResponseStatus(/** @scrutinizer ignore-type */ $result)) {
            $this->{$attribute} = null;

            return true;
        }

        return false;
    }

    /**
     * Retrieves the URL for a given model file attribute.
     * 
     * @param string $attribute Attribute name which holds the filename
     * 
     * @return string URL to access file
     */
    public function getFileUrl($attribute)
    {
        if (empty($this->{$attribute})) {
            return '';
        }

        return $this->getS3Component()->getUrl($this->getAttributePath($attribute) . $this->{$attribute});
    }

    /**
     * Retrieves the presigned URL for a given model file attribute.
     * 
     * @param string $attribute Attribute name which holds the filename
     * 
     * @return string Presigned URL to access file
     */
    public function getFilePresignedUrl($attribute)
    {
        if (empty($this->{$attribute})) {
            return '';
        }

        return $this->getS3Component()->getPresignedUrl(
            $this->getAttributePath($attribute) . $this->{$attribute},
            $this->getPresignedUrlDuration()
        );
    }

    /**
     * Retrieves the URL signature expiration.
     * 
     * @return mixed URL expiration
     */
    protected function getPresignedUrlDuration()
    {
        return '+30 minutes';
    }

    /**
     * Retrieves the base path on AWS S3 for a given attribute.
     * @see attributePaths()
     * 
     * @param string $attribute Attribute to get its path
     * 
     * @return string The path where all file of that attribute should be stored. Returns empty string if the attribute isn't in the list.
     */
    protected function getAttributePath($attribute)
    {
        $paths = $this->attributePaths();
        if (array_key_exists($attribute, $paths)) {
            return $paths[$attribute];
        }

        return '';
    }

    /**
     * List the paths on AWS S3 to each model file attribute.
     * It must be a Key-Value array, where Key is the attribute name and Value is the base path for the file in S3.
     * Override this method for saving each attribute in its own "folder".
     * 
     * @return array Key-Value of attributes and its paths.
     */
    protected function attributePaths()
    {
        return [];
    }

    /**
     * Check for valid status code from the AWS S3 response.
     * Success responses will be considered status codes is 2**.
     * Override function for custom validations.
     * 
     * @param \Aws\ResultInterface $response AWS S3 response containing the status code
     * 
     * @return bool whether this response is successful.
     */
    protected function isSuccessResponseStatus($response)
    {
        return !empty($response->get('@metadata')['statusCode']) &&
            $response->get('@metadata')['statusCode'] >= 200 &&
            $response->get('@metadata')['statusCode'] < 300;
    }
}


sugeng-sulistiyawan / yii2-aws-s3

Push — main ( 839ea2...8564cc )

ModelTrait::removeFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like