csphere\core\files\Upload

Complexity

Total Complexity

17

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setFilter()	0	4	1
B	uploadFile()	0	25	5
A	_controlConsistency()	0	18	4
A	_moveFile()	0	21	3
A	createFolder()	0	14	3
A	_sanitizeName()	0	7	1

<?php

/**
 * File Uploads
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Files
 * @author    Daniel Schalla <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\files;

/**
 * File Uploads
 *
 * @category  Core
 * @package   Files
 * @author    Daniel Schalla <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

class Upload
{
    /**

Missing short description in doc comment

     * @var String Defines after which ruleset the validation class controls
     */

    private $_filter = "";

    /**
     * Sets the filter for the validation class
     *
     * @param string $filter FilterSet (See Validate)
     *
     * @return void
     */

There must be no blank lines after the function comment

    public function setFilter($filter)
    {
        $this->_filter = $filter;
    }

    /**
     * Uploads a file into the storage folder
     *
     * @param array  $file       Array of the file which should be uploaded,
     *                           using the $_FILES Array
     * @param string $plugin     Plugin Name
     * @param string $customName Rename File to $name
     *                           Class
     *
     * @return array
     **/

There must be no blank lines after the function comment

    public function uploadFile($file, $plugin, $customName = "")
    {

        $validate = new Validate($file);

        if (!empty($this->_filter) && !$validate->check($this->_filter)) {
            return false;
        }

        //Determine if the File Array is consistent
        if (!$this->_controlConsistency($file)) {
            return false;
        }

        $customName = $this->_sanitizeName($customName);

        //Try to upload the file in our destination folder
        if ($this->_moveFile($file, $plugin, $customName)) {
            $return = true;
        } else {
            $return = false;
        }

        return $return;
    }

    /**
     * Controls if our $file Array consists all data we require
     *
     * @param array $file The child of the $_FILES
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    private function _controlConsistency($file)
    {
        $consistent = 1;

        if ($file['error'] != 0) {
            $consistent = 0;
        }

        if (empty($file['tmp_name'])) {
            $consistent = 0;
        }

        if ($file['size'] == 0) {
            $consistent = 0;
        }

        return (boolean)$consistent;
    }

    /**
     * Move the uploaded file
     *
     * @param array  $file       File Array
     * @param string $plugin     Plugin Name
     * @param string $customName Customname for the final file
     *
     * @return string
     */

There must be no blank lines after the function comment

    private function _moveFile($file, $plugin, $customName)
    {

        $path = "csphere/storage/uploads/" . $plugin . "/";

        $this->createFolder($path);

        if ($customName != '') {
            $filename = $customName;
        } else {
            $filename = $file['name'];
        }

        if (move_uploaded_file($file['tmp_name'], $path . $filename)) {
            $filePath = $path . $filename;
        } else {
            $filePath = "";
        }

        return $filePath;
    }

    /**
     * Create a destination Folder
     *
     * @param string $path Filepath of the Folder
     *
     * @throws \ErrorException
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public function createFolder($path)
    {

        if (!is_dir($path)) {
            $res = mkdir($path);
            if (!$res) {
                throw new \ErrorException("Couldn't create folder: " . $path);
            }
        } else {
            $res = false;
        }

        return $res;
    }


    /**
     * Filters the name string
     * TODO Filter for invalid characters, only allow [1-9A-Za-z]
     *
     * @param String $name the name to filter
     *
     * @return String the string where spaces where replaces through -
     **/
    private function _sanitizeName($name)
    {

        $name = str_replace(" ", "-", $name);

        return $name;
    }

}