aminyazdanpanah / handling-file-uploads

src/Save.php

<?php

/**
 * Copyright 2019 Amin Yazdanpanah<http://www.aminyazdanpanah.com>.
 *
 * Licensed under the MIT License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://opensource.org/licenses/MIT
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace AYazdanpanah\SaveUploadedFiles;


use AYazdanpanah\SaveUploadedFiles\Exception\Exception;
use AYazdanpanah\SaveUploadedFiles\Exception\SaveExceptionInterface;

abstract class Save implements FileInterface
{

    /**
     * @var Validator
     */
    private $validator;

    /**
     * @var string
     */
    private $path = '';

    /**
     * @var string
     */
    private $file_path = '';

    /**
     * @var bool
     */
    private $override;
    /**
     * @var mixed
     */
    private $save_as;

    /**
     * @var mixed
     */
    private $export_data;

    /**
     * @param $path
     * @param callable $export
     * @return array
     */
    public function save($path, callable $export)
    {
        $this->path = $path;

        try {
            $this->validate();
            $this->moveFile();
            $this->export($export);
            return $this->output(true, "The file \"" . $this->getBaseNameFile() . "\" has been uploaded.");
        } catch (SaveExceptionInterface $e) {
            return $this->output(false, $e->getMessage());

The method getMessage() does not exist on AYazdanpanah\SaveUploadedFiles\Exception\SaveExceptionInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to AYazdanpanah\SaveUploadedFiles\Exception\SaveExceptionInterface.

        }
    }

    /**
     * @throws Exception
     */
    private function validate()
    {
        $this->validator
            ->setFileSize($this->getFileSize())
            ->setFileExtension($this->getFileExtension())
            ->validate();
    }

    /**
     * @throws Exception
     */
    private function moveFile()
    {
        if (!is_dir($this->path)) {
            mkdir($this->path, 0777, true);
        }

        if (null !== $this->getSaveAs()) {

The condition null !== $this->getSaveAs() is always true.

            $this->file_path = $this->path . "/" . $this->getSaveAs() . "." . $this->getFileExtension();
        } else {
            $this->file_path = $this->path . "/" . $this->getbasenamefile();
        }

        if (!$this->isOverride() && file_exists($this->file_path)) {
            throw new Exception("Sorry, file already exists. The file path: \"" . $this->file_path . "\"");
        }

        if (!move_uploaded_file($this->getFileTmpName(), $this->file_path)) {
            throw new Exception("Sorry, there was an error uploading your file. Maybe the path does not have permission to write");
        }
    }

    /**
     * @param $status
     * @param $output
     * @return array
     */
    private function output($status, $output)
    {
        $output = [
            'status' => $status,
            'output' => $output,
        ];

        try {
            $output = array_merge(
                $output,
                [
                    'file_details' => [
                        'name' => $this->getFileName(),
                        'type' => $this->getFileType(),
                        'tmp_name' => $this->getFileTmpName(),
                        'size' => $this->getFileSize(),
                        'extension' => $this->getFileExtension(),
                        'basename' => $this->getbasenamefile(),
                        'save_as' => (null === $this->getSaveAs()) ? $this->getbasenamefile() : $this->getSaveAs() . '.' . $this->getFileExtension(),

The condition null === $this->getSaveAs() is always false.

                        'dir_path' => $this->path,
                        'file_path' => $this->file_path,
                        'upload_datetime' => date("Y-m-d H:i:s"),
                        'stat' => !is_file($this->file_path)?:stat($this->file_path),
                        'mime_content_type' => !is_file($this->file_path)?:mime_content_type($this->file_path),
                        'export' => $this->export_data,
                    ]
                ]
            );
        } catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

        }

        return $output;
    }

    /**
     * @param bool $override
     * @return Save
     */
    public function setOverride(bool $override): Save
    {
        $this->override = $override;
        return $this;
    }

    /**
     * @return bool
     */
    public function isOverride(): bool
    {
        return $this->override;
    }

    /**
     * @param mixed $save_as
     * @return Save
     */
    public function setSaveAs($save_as): Save
    {
        $this->save_as = $save_as;
        return $this;
    }

    /**
     * @return string
     */
    public function getSaveAs()
    {
        return $this->save_as;
    }

    private function export(callable $export)
    {
        $this->export_data = $export($this->file_path);
    }

    /**
     * @param Validator $validator
     * @return Save
     */
    public function setValidator(Validator $validator): Save
    {
        $this->validator = $validator;
        return $this;
    }
}