DownloadsController - Code Metrics - OmarElGabry/miniPHP - Measure and Improve Code Quality continuously with Scrutinizer

DownloadsController A
last analyzed 2018-01-04 10:22 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes

Metric	Value
wmc	6
lcom	2
cbo	6
dl	0
loc	66
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	beforeAction()	11	1
A	download()	18	3
A	users()	5	1
A	isAuthorized()	15	1

<?php

/**
 * Downloads controller
 *
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 * @author     Omar El Gabry <[email protected]>
 */
class DownloadsController extends Controller {
namespace YourVendor;

class YourClass { }


    public function beforeAction(){

        parent::beforeAction();

        $actions = ['download', 'users'];
        $this->Security->requireGet($actions);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        // if you want to add csrf_token in the URL of file download
        // So, it will be something like this: http://localhost/miniPHP/downloads/download/f850749b62bf3badfb6c0?csrf_token=21eb0f2c6b4fddce8a7f3
        // $this->Security->config("validateCsrfToken", true);

    }

    /**
     * download a file provided by it's hashed name
     * the url should be something like: http://localhost/miniPHP/downloads/download/f850749b62bf3ba57b6380b67c6f3096bcdfb6c0
     *
     * @param string $hashedFileName
     */
    public function download($hashedFileName = ''){

        $fullPath = APP . "uploads/" ;
        $file = $this->file->getByHashedName($hashedFileName);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if(empty($file)){
            return $this->error(404);
        }

        $fullPath .= $hashedFileName . "." . $file["extension"];
        $file["basename"] = $file["filename"] . "." . $file["extension"];

        if(!Uploader::isFileExists($fullPath)){
            return $this->error(404);
        }

        $this->response->download($fullPath, ["basename" => $file["basename"], "extension" => $file["extension"]]);
    }

    /**
     * download users data as csv file
     *
     */
    public function users(){

        $data = $this->admin->getUsersData();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->response->csv(["cols" => $data["cols"], "rows" => $data["rows"]], ["filename" => $data["filename"]]);
    }

    public function isAuthorized(){

        $action = $this->request->param('action');
        $role = Session::getUserRole();
        $resource = "downloads";

        //only for admin
        Permission::allow('admin', $resource, "*");

        //only for normal users
        Permission::allow('user', $resource, "download");

        return Permission::check($role, $resource, $action);

    }
}


1			<?php
2
3			/**
4			* Downloads controller
5			*
6			* @license http://opensource.org/licenses/MIT The MIT License (MIT)
7			* @author Omar El Gabry <[email protected]>
8			*/
9			class DownloadsController extends Controller {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10
11
12			public function beforeAction(){
13
14			parent::beforeAction();
15
16			$actions = ['download', 'users'];
17			$this->Security->requireGet($actions);
			0 ignored issues – show Documentation introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report The property `Security` does not exist on `object<DownloadsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
18
19			// if you want to add csrf_token in the URL of file download
20			// So, it will be something like this: http://localhost/miniPHP/downloads/download/f850749b62bf3badfb6c0?csrf_token=21eb0f2c6b4fddce8a7f3
21			// $this->Security->config("validateCsrfToken", true);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-19 21:07 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
22			}
23
24			/**
25			* download a file provided by it's hashed name
26			* the url should be something like: http://localhost/miniPHP/downloads/download/f850749b62bf3ba57b6380b67c6f3096bcdfb6c0
27			*
28			* @param string $hashedFileName
29			*/
30			public function download($hashedFileName = ''){
31
32			$fullPath = APP . "uploads/" ;
33			$file = $this->file->getByHashedName($hashedFileName);
			0 ignored issues – show Documentation introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report The property `file` does not exist on `object<DownloadsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
34
35			if(empty($file)){
36			return $this->error(404);
37			}
38
39			$fullPath .= $hashedFileName . "." . $file["extension"];
40			$file["basename"] = $file["filename"] . "." . $file["extension"];
41
42			if(!Uploader::isFileExists($fullPath)){
43			return $this->error(404);
44			}
45
46			$this->response->download($fullPath, ["basename" => $file["basename"], "extension" => $file["extension"]]);
47			}
48
49			/**
50			* download users data as csv file
51			*
52			*/
53			public function users(){
54
55			$data = $this->admin->getUsersData();
			0 ignored issues – show Documentation introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report The property `admin` does not exist on `object<DownloadsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
56			$this->response->csv(["cols" => $data["cols"], "rows" => $data["rows"]], ["filename" => $data["filename"]]);
57			}
58
59			public function isAuthorized(){
60
61			$action = $this->request->param('action');
62			$role = Session::getUserRole();
63			$resource = "downloads";
64
65			//only for admin
66			Permission::allow('admin', $resource, "*");
67
68			//only for normal users
69			Permission::allow('user', $resource, "download");
70
71			return Permission::check($role, $resource, $action);
72
73			}
74			}
75

OmarElGabry / miniPHP

GitHub Access Token became invalid

DownloadsController A last analyzed 2018-01-04 10:22 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like

DownloadsController A
last analyzed 2018-01-04 10:22 UTC