ContentsFileHelper - Code Metrics - Inspection of "静的対応用にファイル名がフィールド名だったものをランダム文字列も設定可能なように修正" - satthi/Contents-file - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#26)

by satoru

created 2017-02-08 05:23 UTC

ContentsFileHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	199
Duplicated Lines	11.06 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	10
Bugs	0	Features	0

Metric	Value
wmc	29
lcom	1
cbo	2
dl	22
loc	199
rs	10
c	10
b	0
f	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	link()	4	24	4
A	contentsFileHidden()	0	10	3
C	urlArray()	0	44	7
A	image()	4	18	4
A	url()	0	14	3
C	makeStaticS3Url()	14	34	8

How to fix Duplicated Code

<?php

namespace ContentsFile\View\Helper;

use Cake\Core\Configure;
use Cake\View\Helper;

class ContentsFileHelper extends Helper {

    public $helpers = ['Html', 'Url', 'Form'];
    private $defaultOption = [
        'target' => '_blank',
        'escape' => false,
        'download' => false
    ];

    /**
     * link
     * @author hagiwara
     * @param array $fileInfo
     * @param array $options
     * @param string $title
     */
    public function link($fileInfo, $options = [], $title = null)
    {
        if (empty($fileInfo)) {
            return '';
        }
        //一時パス用の設定
        if ($title === null) {
            $title = $fileInfo['file_name'];
        }
        if (isset($options['resize'])) {

            $fileInfo['resize'] = $options['resize'];
            unset($options['resize']);
        }
        $options = array_merge(
            $this->defaultOption,
            $options
        );

        return $this->Html->link(
<?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.");
        }
    }

}
            $title,
            $this->urlArray($fileInfo, $options),
            $options
        );
    }

    /**
     * image
     * @author hagiwara
     * @param array $fileInfo
     * @param array $options
     */
    public function image($fileInfo, $options = [])
    {
        if (empty($fileInfo)) {
            return '';
        }
        $options = array_merge(
            $this->defaultOption,
            $options
        );
        if (!empty($fileInfo)) {
            if (isset($options['resize'])) {

                $fileInfo['resize'] = $options['resize'];
                unset($options['resize']);
            }
            return $this->Html->image($this->urlArray($fileInfo, $options), $options);
<?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.");
        }
    }

}
        }
        return '';
    }

    /**
     * url
     * @author hagiwara
     * @param array $fileInfo
     * @param boolean $full
     * @param array $options
     */
    public function url($fileInfo, $full = false, $options = [])
    {
        if (empty($fileInfo)) {
            return [];
        }
        if (!isset($fileInfo['resize'])) {
            $fileInfo['resize'] = false;
        }
        $options = array_merge(
            $this->defaultOption,
            $options
        );
        return $this->Url->build($this->urlArray($fileInfo, $options), $full);
<?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.");
        }
    }

}
    }

    /**
     * contentsFileHidden
     *
     * バリデーションに引っかかった際にファイルをそのまま送る用
     *
     * @author hagiwara
     * @param array|null $contentFileData
     * @param text $field
     */
    public function contentsFileHidden($contentFileData, $field)
    {
        $hiddenInput = '';
        if (!empty($contentFileData)) {
            foreach ($contentFileData as $fieldParts => $v) {
                $hiddenInput .= $this->Form->input($field . '.' . $fieldParts, ['type' => 'hidden']);
<?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.");
        }
    }

}
            }
        }
        return $hiddenInput;
    }

    /**
     * urlArray
     * @author hagiwara
     * @param array $fileInfo
     */
    private function urlArray($fileInfo, $options)
    {
        if (!empty($fileInfo['tmp_file_name'])) {
            return [
                'controller' => 'contents_file',
                'action' => 'loader',
                'plugin' => 'ContentsFile',
                'model' => $fileInfo['model'],
                'field_name' => $fileInfo['field_name'],
                'tmp_file_name' => $fileInfo['tmp_file_name'],
                // prefixは無視する
                'prefix' => false,
                'download' => $options['download'],
            ];
        } else {
            if (!isset($fileInfo['resize'])) {
                $fileInfo['resize'] = false;
            }
            // S3のホスティングの場合
            // downloadとかはつけられないので無視
            if (
                array_key_exists('static_s3', $options) &&
                $options['static_s3'] == true &&
                Configure::read('ContentsFile.Setting.type') == 's3' &&
                !is_null(Configure::read('ContentsFile.Setting.S3.static_domain'))
            ) {
                return $this->makeStaticS3Url($fileInfo);
            } else {
                // loaderを通す場合
                return [
                    'controller' => 'contents_file',
                    'action' => 'loader',
                    'plugin' => 'ContentsFile',
                    'model' => $fileInfo['model'],
                    'field_name' => $fileInfo['field_name'],
                    'model_id' => $fileInfo['model_id'],
                    'resize' => $fileInfo['resize'],
                    // prefixは無視する
                    'prefix' => false,
                    'download' => $options['download'],
                ];
            }
        }
    }

    /**
     * makeStaticS3Url
     * 静的ホスティング用のURL作成
     * @author hagiwara
     * @param array $fileInfo
     */
    private function makeStaticS3Url($fileInfo)
    {
        $staticS3Url = Configure::read('ContentsFile.Setting.S3.static_domain') . '/' . Configure::read('ContentsFile.Setting.S3.fileDir') . $fileInfo['model'] . '/' . $fileInfo['model_id'] . '/';
        if ($fileInfo['resize'] == false) {
            if (Configure::read('ContentsFile.Setting.randomFile') === true && $fileInfo['file_random_path'] != '') {
                $staticS3Url .= $fileInfo['file_random_path'];
            } else {
                $staticS3Url .= $fileInfo['field_name'];
            }
        } else {
            $resizeText = '';
            if (

                empty($fileInfo['resize']['width'])
            ) {
                $resizeText .= '0';
            } else {
                $resizeText .= $fileInfo['resize']['width'];
            }
            $resizeText .= '_';
            if (

                empty($fileInfo['resize']['height'])
            ) {
                $resizeText .= '0';
            } else {
                $resizeText .= $fileInfo['resize']['height'];
            }
            if (Configure::read('ContentsFile.Setting.randomFile') === true && $fileInfo['file_random_path'] != '') {
                $staticS3Url .= 'contents_file_resize_' . $fileInfo['file_random_path'] . '/' . $resizeText;
            } else {
                $staticS3Url .= 'contents_file_resize_' . $fileInfo['field_name'] . '/' . $resizeText;
            }
        }
        return $staticS3Url;
    }
}


1		<?php
2
3		namespace ContentsFile\View\Helper;
4
5		use Cake\Core\Configure;
6		use Cake\View\Helper;
7
8		class ContentsFileHelper extends Helper {
9
10		public $helpers = ['Html', 'Url', 'Form'];
11		private $defaultOption = [
12		'target' => '_blank',
13		'escape' => false,
14		'download' => false
15		];
16
17		/**
18		* link
19		* @author hagiwara
20		* @param array $fileInfo
21		* @param array $options
22		* @param string $title
23		*/
24		public function link($fileInfo, $options = [], $title = null)
25		{
26		if (empty($fileInfo)) {
27		return '';
28		}
29		//一時パス用の設定
30		if ($title === null) {
31		$title = $fileInfo['file_name'];
32		}
33	View Code Duplication	if (isset($options['resize'])) {
		0 ignored issues – show Duplication introduced 2016-11-09 10:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
34		$fileInfo['resize'] = $options['resize'];
35		unset($options['resize']);
36		}
37		$options = array_merge(
38		$this->defaultOption,
39		$options
40		);
41
42		return $this->Html->link(
		0 ignored issues – show Documentation introduced 2016-11-09 10:12 UTC by Report Bug Copy Issue Report The property `Html` does not exist on `object<ContentsFile\View...per\ContentsFileHelper>`. 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...
43		$title,
44		$this->urlArray($fileInfo, $options),
45		$options
46		);
47		}
48
49		/**
50		* image
51		* @author hagiwara
52		* @param array $fileInfo
53		* @param array $options
54		*/
55		public function image($fileInfo, $options = [])
56		{
57		if (empty($fileInfo)) {
58		return '';
59		}
60		$options = array_merge(
61		$this->defaultOption,
62		$options
63		);
64		if (!empty($fileInfo)) {
65	View Code Duplication	if (isset($options['resize'])) {
		0 ignored issues – show Duplication introduced 2016-11-09 10:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
66		$fileInfo['resize'] = $options['resize'];
67		unset($options['resize']);
68		}
69		return $this->Html->image($this->urlArray($fileInfo, $options), $options);
		0 ignored issues – show Documentation introduced 2016-11-09 10:26 UTC by Report Bug Copy Issue Report The property `Html` does not exist on `object<ContentsFile\View...per\ContentsFileHelper>`. 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...
70		}
71		return '';
72		}
73
74		/**
75		* url
76		* @author hagiwara
77		* @param array $fileInfo
78		* @param boolean $full
79		* @param array $options
80		*/
81		public function url($fileInfo, $full = false, $options = [])
82		{
83		if (empty($fileInfo)) {
84		return [];
85		}
86		if (!isset($fileInfo['resize'])) {
87		$fileInfo['resize'] = false;
88		}
89		$options = array_merge(
90		$this->defaultOption,
91		$options
92		);
93		return $this->Url->build($this->urlArray($fileInfo, $options), $full);
		0 ignored issues – show Documentation introduced 2016-11-09 10:26 UTC by Report Bug Copy Issue Report The property `Url` does not exist on `object<ContentsFile\View...per\ContentsFileHelper>`. 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...
94		}
95
96		/**
97		* contentsFileHidden
98		*
99		* バリデーションに引っかかった際にファイルをそのまま送る用
100		*
101		* @author hagiwara
102		* @param array\|null $contentFileData
103		* @param text $field
104		*/
105		public function contentsFileHidden($contentFileData, $field)
106		{
107		$hiddenInput = '';
108		if (!empty($contentFileData)) {
109		foreach ($contentFileData as $fieldParts => $v) {
110		$hiddenInput .= $this->Form->input($field . '.' . $fieldParts, ['type' => 'hidden']);
		0 ignored issues – show Documentation introduced 2017-01-30 11:00 UTC by Report Bug Copy Issue Report The property `Form` does not exist on `object<ContentsFile\View...per\ContentsFileHelper>`. 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...
111		}
112		}
113		return $hiddenInput;
114		}
115
116		/**
117		* urlArray
118		* @author hagiwara
119		* @param array $fileInfo
120		*/
121		private function urlArray($fileInfo, $options)
122		{
123		if (!empty($fileInfo['tmp_file_name'])) {
124		return [
125		'controller' => 'contents_file',
126		'action' => 'loader',
127		'plugin' => 'ContentsFile',
128		'model' => $fileInfo['model'],
129		'field_name' => $fileInfo['field_name'],
130		'tmp_file_name' => $fileInfo['tmp_file_name'],
131		// prefixは無視する
132		'prefix' => false,
133		'download' => $options['download'],
134		];
135		} else {
136		if (!isset($fileInfo['resize'])) {
137		$fileInfo['resize'] = false;
138		}
139		// S3のホスティングの場合
140		// downloadとかはつけられないので無視
141		if (
142		array_key_exists('static_s3', $options) &&
143		$options['static_s3'] == true &&
144		Configure::read('ContentsFile.Setting.type') == 's3' &&
145		!is_null(Configure::read('ContentsFile.Setting.S3.static_domain'))
146		) {
147		return $this->makeStaticS3Url($fileInfo);
148		} else {
149		// loaderを通す場合
150		return [
151		'controller' => 'contents_file',
152		'action' => 'loader',
153		'plugin' => 'ContentsFile',
154		'model' => $fileInfo['model'],
155		'field_name' => $fileInfo['field_name'],
156		'model_id' => $fileInfo['model_id'],
157		'resize' => $fileInfo['resize'],
158		// prefixは無視する
159		'prefix' => false,
160		'download' => $options['download'],
161		];
162		}
163		}
164		}
165
166		/**
167		* makeStaticS3Url
168		* 静的ホスティング用のURL作成
169		* @author hagiwara
170		* @param array $fileInfo
171		*/
172		private function makeStaticS3Url($fileInfo)
173		{
174		$staticS3Url = Configure::read('ContentsFile.Setting.S3.static_domain') . '/' . Configure::read('ContentsFile.Setting.S3.fileDir') . $fileInfo['model'] . '/' . $fileInfo['model_id'] . '/';
175		if ($fileInfo['resize'] == false) {
176		if (Configure::read('ContentsFile.Setting.randomFile') === true && $fileInfo['file_random_path'] != '') {
177		$staticS3Url .= $fileInfo['file_random_path'];
178		} else {
179		$staticS3Url .= $fileInfo['field_name'];
180		}
181		} else {
182		$resizeText = '';
183	View Code Duplication	if (
		0 ignored issues – show Duplication introduced 2017-02-08 05:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
184		empty($fileInfo['resize']['width'])
185		) {
186		$resizeText .= '0';
187		} else {
188		$resizeText .= $fileInfo['resize']['width'];
189		}
190		$resizeText .= '_';
191	View Code Duplication	if (
		0 ignored issues – show Duplication introduced 2017-02-08 05:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
192		empty($fileInfo['resize']['height'])
193		) {
194		$resizeText .= '0';
195		} else {
196		$resizeText .= $fileInfo['resize']['height'];
197		}
198		if (Configure::read('ContentsFile.Setting.randomFile') === true && $fileInfo['file_random_path'] != '') {
199		$staticS3Url .= 'contents_file_resize_' . $fileInfo['file_random_path'] . '/' . $resizeText;
200		} else {
201		$staticS3Url .= 'contents_file_resize_' . $fileInfo['field_name'] . '/' . $resizeText;
202		}
203		}
204		return $staticS3Url;
205		}
206		}
207

satthi / Contents-file

Pull Request — master (#26)

ContentsFileHelper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like