GetAction::run() - Code Metrics - Inspection of "Added missed ukrainian translations" - vova07/yii2-imperavi-widget - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#81)

unknown

created 2017-03-12 15:40 UTC

GetAction::run() A

↳ Parent: GetAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php

namespace the0rist\imperavi\actions;

use Yii;
use yii\base\Action;
use yii\base\InvalidCallException;
use yii\base\InvalidConfigException;
use yii\web\Response;
use the0rist\imperavi\helpers\FileHelper;

/**
 * Class GetAction
 * @package the0rist\imperavi\actions
 *
 * GetAction returns a JSON array of the files found under the specified directory and subdirectories.
 * This array can be used in Imperavi Redactor to insert some files that have already been uploaded.
 *
 * Usage:
 *
 * ```php
 * public function actions()
 * {
 *     return [
 *         'get-image' => [
 *             'class' => GetAction::className(),
 *             'url' => 'http://my-site.com/statics/',
 *             'path' => '/var/www/my-site.com/web/statics',
 *             'type' => GetAction::TYPE_IMAGES,
 *         ]
 *     ];
 * }
 * ```
 *
 * @author Vasile Crudu <[email protected]>
 *
 * @link https://github.com/the0rist
 */
class GetAction extends Action
{
    /** Image type */
    const TYPE_IMAGES = 0;
    /** File type */
    const TYPE_FILES = 1;

    /**
     * @var string Files directory
     */
    public $path;

    /**
     * @var string Files directory URL
     */
    public $url;

    /**
     * [\the0rist\imperavi\helpers\FileHelper::findFiles()|FileHelper::findFiles()] options argument.
     * @var array Options
     */
    public $options = [];

    /**
     * @var int return type (images or files)
     */
    public $type = self::TYPE_IMAGES;

    /**
     * @inheritdoc
     */
    public function init()
    {
        if ($this->url === null) {
            throw new InvalidConfigException('The "url" attribute must be set.');
        } else {
            $this->options['url'] = $this->url;
        }
        if ($this->path === null) {
            throw new InvalidConfigException('The "path" attribute must be set.');
        } else {
            $this->path = Yii::getAlias($this->path);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }
    }

    /**
     * @inheritdoc
     */
    public function run()
    {
        Yii::$app->response->format = Response::FORMAT_JSON;
        return FileHelper::findFiles($this->path, $this->options, $this->type);
    }
}


1			<?php
2
3			namespace the0rist\imperavi\actions;
4
5			use Yii;
6			use yii\base\Action;
7			use yii\base\InvalidCallException;
8			use yii\base\InvalidConfigException;
9			use yii\web\Response;
10			use the0rist\imperavi\helpers\FileHelper;
11
12			/**
13			* Class GetAction
14			* @package the0rist\imperavi\actions
15			*
16			* GetAction returns a JSON array of the files found under the specified directory and subdirectories.
17			* This array can be used in Imperavi Redactor to insert some files that have already been uploaded.
18			*
19			* Usage:
20			*
21			* ```php
22			* public function actions()
23			* {
24			* return [
25			* 'get-image' => [
26			* 'class' => GetAction::className(),
27			* 'url' => 'http://my-site.com/statics/',
28			* 'path' => '/var/www/my-site.com/web/statics',
29			* 'type' => GetAction::TYPE_IMAGES,
30			* ]
31			* ];
32			* }
33			* ```
34			*
35			* @author Vasile Crudu <[email protected]>
36			*
37			* @link https://github.com/the0rist
38			*/
39			class GetAction extends Action
40			{
41			/** Image type */
42			const TYPE_IMAGES = 0;
43			/** File type */
44			const TYPE_FILES = 1;
45
46			/**
47			* @var string Files directory
48			*/
49			public $path;
50
51			/**
52			* @var string Files directory URL
53			*/
54			public $url;
55
56			/**
57			* [\the0rist\imperavi\helpers\FileHelper::findFiles()\|FileHelper::findFiles()] options argument.
58			* @var array Options
59			*/
60			public $options = [];
61
62			/**
63			* @var int return type (images or files)
64			*/
65			public $type = self::TYPE_IMAGES;
66
67			/**
68			* @inheritdoc
69			*/
70			public function init()
71			{
72			if ($this->url === null) {
73			throw new InvalidConfigException('The "url" attribute must be set.');
74			} else {
75			$this->options['url'] = $this->url;
76			}
77			if ($this->path === null) {
78			throw new InvalidConfigException('The "path" attribute must be set.');
79			} else {
80			$this->path = Yii::getAlias($this->path);
			0 ignored issues – show Documentation Bug introduced 2015-12-10 21:30 UTC by Report Bug Copy Issue Report It seems like `\Yii::getAlias($this->path)` can also be of type `boolean`. However, the property `$path` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
81			}
82			}
83
84			/**
85			* @inheritdoc
86			*/
87			public function run()
88			{
89			Yii::$app->response->format = Response::FORMAT_JSON;
90			return FileHelper::findFiles($this->path, $this->options, $this->type);
91			}
92			}
93

vova07 / yii2-imperavi-widget

Pull Request — master (#81)

GetAction::run() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like