ModelTrait::getFilePresignedUrl() - Code Metrics - sugeng-sulistiyawan/yii2-flysystem - Measure and Improve Code Quality continuously with Scrutinizer

ModelTrait::getFilePresignedUrl() A
last analyzed 2024-10-25 08:18 UTC

↳ Parent: ModelTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	5
c	2
b	0
f	0
dl	0
loc	9
rs	10
cc	2
nc	2
nop	1

<?php

namespace diecoding\flysystem\traits;

use Yii;
use yii\web\UploadedFile;

/**
 * Trait ModelTrait for Model
 * 
 * @link      https://sugengsulistiyawan.my.id/
 * @author    Sugeng Sulistiyawan <[email protected]>
 * @copyright Copyright (c) 2023
 */
trait ModelTrait
{
    /**
     * @return \diecoding\flysystem\AbstractComponent|mixed
     */
    public function getFsComponent()
    {
        return Yii::$app->get('fs');
    }

    /**
     * Save UploadedFile.
     * ! 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 $autoExtension `true` to automatically append or replace the extension to the file name. Default is `true`
     * 
     * @return void
     */
    public function saveUploadedFile(UploadedFile $file, $attribute, $fileName = '', $autoExtension = true)
    {
        if ($this->hasErrors()) {
            return;
        }
        if (empty($fileName)) {
            $fileName = $file->name;
        }
        if ($autoExtension) {
            $_file = (string) pathinfo($fileName, PATHINFO_FILENAME);
            $fileName = $_file . '.' . $file->extension;
        }

        $this->{$attribute} = $fileName;
        if (!$this->validate($attribute)) {
            return;
        }
        $filePath = $this->getAttributePath($attribute) . '/' . $fileName;
        $localPath = $file->tempName;
        $handle = fopen($localPath, 'r');
        $contents = fread($handle, filesize($localPath));
        fclose($handle);

        $filesystem = $this->getFsComponent();
        $filesystem->write($filesystem->normalizePath($filePath), $contents);
    }

    /**
     * Delete model file attribute.
     * 
     * @param string $attribute Attribute name which holds the filename
     * 
     * @return void
     */
    public function removeFile($attribute)
    {
        if (empty($this->{$attribute})) {
            return;
        }
        $filePath = $this->getAttributePath($attribute) . '/' . $this->{$attribute};
        $filesystem = $this->getFsComponent();
        $filesystem->delete($filesystem->normalizePath($filePath));

        $this->{$attribute} = null;
    }

    /**
     * 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 '';
        }
        $filePath = $this->getAttributePath($attribute) . '/' . $this->{$attribute};
        $filesystem = $this->getFsComponent();

        return $filesystem->publicUrl($filesystem->normalizePath($filePath));
    }

    /**
     * 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 '';
        }
        $filePath = $this->getAttributePath($attribute) . '/' . $this->{$attribute};
        $filesystem = $this->getFsComponent();

        return $filesystem->temporaryUrl($filesystem->normalizePath($filePath), $this->getPresignedUrlDuration($attribute));
    }

    /**
     * List the paths on filesystem 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 filesystem.
     * Override this method for saving each attribute in its own "folder".
     * 
     * @return array Key-Value of attributes and its paths.
     */
    protected function attributePaths()
    {
        return [];
    }

    /**
     * Retrieves the URL signature expiration.
     * 
     * @param string $attribute Attribute name which holds the duration
     * 
     * @return \DateTimeInterface URL expiration
     */
    protected function getPresignedUrlDuration($attribute)
    {
        $filesystem = $this->getFsComponent();
        $dateValue = '+5 Minutes';

        if (empty($this->{$attribute})) {
            $dateValue = 'now';
        }

        return $filesystem->convertToDateTime($dateValue);
    }

    /**
     * Retrieves the base path on filesystem 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 '';
    }

    /**
     * Returns a value indicating whether there is any validation error.
     * @param string|null $attribute attribute name. Use null to check all attributes.
     * @return bool whether there is any error.
     */
    abstract public function hasErrors($attribute = null);

    /**
     * Performs the data validation.
     *
     * This method executes the validation rules applicable to the current [[scenario]].
     * The following criteria are used to determine whether a rule is currently applicable:
     *
     * - the rule must be associated with the attributes relevant to the current scenario;
     * - the rules must be effective for the current scenario.
     *
     * This method will call [[beforeValidate()]] and [[afterValidate()]] before and
     * after the actual validation, respectively. If [[beforeValidate()]] returns false,
     * the validation will be cancelled and [[afterValidate()]] will not be called.
     *
     * Errors found during the validation can be retrieved via [[getErrors()]],
     * [[getFirstErrors()]] and [[getFirstError()]].
     *
     * @param string[]|string|null $attributeNames attribute name or list of attribute names
     * that should be validated. If this parameter is empty, it means any attribute listed in
     * the applicable validation rules should be validated.
     * @param bool $clearErrors whether to call [[clearErrors()]] before performing validation
     * @return bool whether the validation is successful without any error.
     * @throws InvalidArgumentException if the current scenario is unknown.
     */
    abstract public function validate($attributeNames = null, $clearErrors = true);
}


1			<?php
2
3			namespace diecoding\flysystem\traits;
4
5			use Yii;
6			use yii\web\UploadedFile;
7
8			/**
9			* Trait ModelTrait for Model
10			*
11			* @link https://sugengsulistiyawan.my.id/
12			* @author Sugeng Sulistiyawan <[email protected]>
13			* @copyright Copyright (c) 2023
14			*/
15			trait ModelTrait
16			{
17			/**
18			* @return \diecoding\flysystem\AbstractComponent\|mixed
19			*/
20			public function getFsComponent()
21			{
22			return Yii::$app->get('fs');
23			}
24
25			/**
26			* Save UploadedFile.
27			* ! Important: This function uploads this model filename to keep consistency of the model.
28			*
29			* @param UploadedFile $file Uploaded file to save
30			* @param string $attribute Attribute name where the uploaded filename name will be saved
31			* @param string $fileName Name which file will be saved. If empty will use the name from $file
32			* @param bool $autoExtension `true` to automatically append or replace the extension to the file name. Default is `true`
33			*
34			* @return void
35			*/
36			public function saveUploadedFile(UploadedFile $file, $attribute, $fileName = '', $autoExtension = true)
37			{
38			if ($this->hasErrors()) {
39			return;
40			}
41			if (empty($fileName)) {
42			$fileName = $file->name;
43			}
44			if ($autoExtension) {
45			$_file = (string) pathinfo($fileName, PATHINFO_FILENAME);
46			$fileName = $_file . '.' . $file->extension;
47			}
48
49			$this->{$attribute} = $fileName;
50			if (!$this->validate($attribute)) {
51			return;
52			}
53			$filePath = $this->getAttributePath($attribute) . '/' . $fileName;
54			$localPath = $file->tempName;
55			$handle = fopen($localPath, 'r');
56			$contents = fread($handle, filesize($localPath));
57			fclose($handle);
58
59			$filesystem = $this->getFsComponent();
60			$filesystem->write($filesystem->normalizePath($filePath), $contents);
61			}
62
63			/**
64			* Delete model file attribute.
65			*
66			* @param string $attribute Attribute name which holds the filename
67			*
68			* @return void
69			*/
70			public function removeFile($attribute)
71			{
72			if (empty($this->{$attribute})) {
73			return;
74			}
75			$filePath = $this->getAttributePath($attribute) . '/' . $this->{$attribute};
76			$filesystem = $this->getFsComponent();
77			$filesystem->delete($filesystem->normalizePath($filePath));
78
79			$this->{$attribute} = null;
80			}
81
82			/**
83			* Retrieves the URL for a given model file attribute.
84			*
85			* @param string $attribute Attribute name which holds the filename
86			*
87			* @return string URL to access file
88			*/
89			public function getFileUrl($attribute)
90			{
91			if (empty($this->{$attribute})) {
92			return '';
93			}
94			$filePath = $this->getAttributePath($attribute) . '/' . $this->{$attribute};
95			$filesystem = $this->getFsComponent();
96
97			return $filesystem->publicUrl($filesystem->normalizePath($filePath));
98			}
99
100			/**
101			* Retrieves the presigned URL for a given model file attribute.
102			*
103			* @param string $attribute Attribute name which holds the filename
104			*
105			* @return string Presigned URL to access file
106			*/
107			public function getFilePresignedUrl($attribute)
108			{
109			if (empty($this->{$attribute})) {
110			return '';
111			}
112			$filePath = $this->getAttributePath($attribute) . '/' . $this->{$attribute};
113			$filesystem = $this->getFsComponent();
114
115			return $filesystem->temporaryUrl($filesystem->normalizePath($filePath), $this->getPresignedUrlDuration($attribute));
116			}
117
118			/**
119			* List the paths on filesystem to each model file attribute.
120			* It must be a Key-Value array, where Key is the attribute name and Value is the base path for the file in filesystem.
121			* Override this method for saving each attribute in its own "folder".
122			*
123			* @return array Key-Value of attributes and its paths.
124			*/
125			protected function attributePaths()
126			{
127			return [];
128			}
129
130			/**
131			* Retrieves the URL signature expiration.
132			*
133			* @param string $attribute Attribute name which holds the duration
134			*
135			* @return \DateTimeInterface URL expiration
136			*/
137			protected function getPresignedUrlDuration($attribute)
138			{
139			$filesystem = $this->getFsComponent();
140			$dateValue = '+5 Minutes';
141
142			if (empty($this->{$attribute})) {
143			$dateValue = 'now';
144			}
145
146			return $filesystem->convertToDateTime($dateValue);
147			}
148
149			/**
150			* Retrieves the base path on filesystem for a given attribute.
151			* see `attributePaths()`
152			*
153			* @param string $attribute Attribute to get its path
154			*
155			* @return string The path where all file of that attribute should be stored. Returns empty string if the attribute isn't in the list.
156			*/
157			protected function getAttributePath($attribute)
158			{
159			$paths = $this->attributePaths();
160			if (array_key_exists($attribute, $paths)) {
161			return $paths[$attribute];
162			}
163
164			return '';
165			}
166
167			/**
168			* Returns a value indicating whether there is any validation error.
169			* @param string\|null $attribute attribute name. Use null to check all attributes.
170			* @return bool whether there is any error.
171			*/
172			abstract public function hasErrors($attribute = null);
173
174			/**
175			* Performs the data validation.
176			*
177			* This method executes the validation rules applicable to the current [[scenario]].
178			* The following criteria are used to determine whether a rule is currently applicable:
179			*
180			* - the rule must be associated with the attributes relevant to the current scenario;
181			* - the rules must be effective for the current scenario.
182			*
183			* This method will call [[beforeValidate()]] and [[afterValidate()]] before and
184			* after the actual validation, respectively. If [[beforeValidate()]] returns false,
185			* the validation will be cancelled and [[afterValidate()]] will not be called.
186			*
187			* Errors found during the validation can be retrieved via [[getErrors()]],
188			* [[getFirstErrors()]] and [[getFirstError()]].
189			*
190			* @param string[]\|string\|null $attributeNames attribute name or list of attribute names
191			* that should be validated. If this parameter is empty, it means any attribute listed in
192			* the applicable validation rules should be validated.
193			* @param bool $clearErrors whether to call [[clearErrors()]] before performing validation
194			* @return bool whether the validation is successful without any error.
195			* @throws InvalidArgumentException if the current scenario is unknown.
196			*/
197			abstract public function validate($attributeNames = null, $clearErrors = true);
198			}
199

sugeng-sulistiyawan / yii2-flysystem

ModelTrait::getFilePresignedUrl() A last analyzed 2024-10-25 08:18 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ModelTrait::getFilePresignedUrl() A
last analyzed 2024-10-25 08:18 UTC