BaseHandler::mkdir() - Code Metrics - Inspection of "minor" - hiqdev/hidev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9bb604...7c4aaf )

by Andrii

created 2016-02-18 16:53 UTC

BaseHandler::mkdir() A

↳ Parent: BaseHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
ccs	0
cts	10
cp	0
rs	9.4285
cc	2
eloc	7
nc	2
nop	1
crap	6

<?php

/*
 * Task runner, code generator and build tool for easier continuos integration
 *
 * @link      https://github.com/hiqdev/hidev
 * @package   hidev
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hidev\handlers;

use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;

/**
 * Base Handler.
 * Knows how to parse and render it's file type.
 */
class BaseHandler extends \yii\base\Object
{
    /**
     * @var Goal
     */
    public $goal;

    /**
     * @var string template file name to be used for rendering
     */
    public $template;

    /**
     * @var View object.
     */
    protected $_view;

    /**
     * Returns the view object that can be used to render views or view files.
     * If not set, it will default to the "view" application component.
     *
     * @return View|\yii\web\View the view object that can be used to render views or view files.
     */
    public function getView()
    {
        if ($this->_view === null) {
            $this->_view = Yii::$app->getView();
        }

        return $this->_view;
    }

    /**
     * Renders prepared data.
     * Must be redefined in child.
     *
     * @param array $data
     *
     * @throws InvalidConfigException
     *
     * @return string file content
     */
    public function renderPrepared(array $data)
    {
        throw new InvalidConfigException('Render not available');
    }

    /**
     * Renders raw data.
     * Prepares data with ArrayHelper::toArray.
     *
     * @param mixed $data
     *
     * @return string file content
     */
    public function render($data)
    {
        return $this->renderPrepared($this->prepareData($data));
    }

    public function prepareData($data)
    {
        return ArrayHelper::toArray($data, [], false);
        #return $data;
    }

    /**
     * Renders file content using given data.
     * Converts to array with ArrayHelper::toArray.
     *
     * @param mixed $data
     *
     * @return string file content
     */
    public function renderPath($path, $data)
    {
        return $this->write($path, $this->render($data));
    }

    public function parsePath($path, $minimal = null)
    {
        return $this->parse($this->read($path));
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Writes given content to the file.
     * Doesn't touch file if it has exactly same content.
     * Creates intermediate directories when necessary.
     * @param string $path
     * @param string $content
     * @return bool true if file was changed
     */
    public function write($path, $content)
    {
        if (!is_file($path) || file_get_contents($path) !== $content) {
            $this->mkdir(dirname($path));
            file_put_contents($path, $content);
            Yii::warning('Written file: ' . $path, 'file');

            return true;
        }

        return false;
    }

    /**
     * Creates directory if not exists.
     * @param string $path
     * @return bool true if directory did not exist and was created
     */
    public function mkdir($path)
    {
        $path = trim(trim($path), '/');
        if (!file_exists($path)) {
            mkdir($path, 0777, true);
            Yii::warning('Created dir:  ' . $path . '/', 'file');

            return true;
        }

        return false;
    }

    public function read($path, $asArray = false)
    {
        if (file_exists($path)) {
            Yii::info('Read file: ' . $path, 'file');

            return $asArray ? file($path) : file_get_contents($path);
        } else {
            Yii::error('Couldn\'t read file: ' . $path, 'file');

            return;
        }
    }

    public function readArray($path)
    {
        return $this->read($path, true);
    }
}


1			<?php
2
3			/*
4			* Task runner, code generator and build tool for easier continuos integration
5			*
6			* @link https://github.com/hiqdev/hidev
7			* @package hidev
8			* @license BSD-3-Clause
9			* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10			*/
11
12			namespace hidev\handlers;
13
14			use Yii;
15			use yii\base\InvalidConfigException;
16			use yii\helpers\ArrayHelper;
17
18			/**
19			* Base Handler.
20			* Knows how to parse and render it's file type.
21			*/
22			class BaseHandler extends \yii\base\Object
23			{
24			/**
25			* @var Goal
26			*/
27			public $goal;
28
29			/**
30			* @var string template file name to be used for rendering
31			*/
32			public $template;
33
34			/**
35			* @var View object.
36			*/
37			protected $_view;
38
39			/**
40			* Returns the view object that can be used to render views or view files.
41			* If not set, it will default to the "view" application component.
42			*
43			* @return View\|\yii\web\View the view object that can be used to render views or view files.
44			*/
45			public function getView()
46			{
47			if ($this->_view === null) {
48			$this->_view = Yii::$app->getView();
49			}
50
51			return $this->_view;
52			}
53
54			/**
55			* Renders prepared data.
56			* Must be redefined in child.
57			*
58			* @param array $data
59			*
60			* @throws InvalidConfigException
61			*
62			* @return string file content
63			*/
64			public function renderPrepared(array $data)
65			{
66			throw new InvalidConfigException('Render not available');
67			}
68
69			/**
70			* Renders raw data.
71			* Prepares data with ArrayHelper::toArray.
72			*
73			* @param mixed $data
74			*
75			* @return string file content
76			*/
77			public function render($data)
78			{
79			return $this->renderPrepared($this->prepareData($data));
80			}
81
82			public function prepareData($data)
83			{
84			return ArrayHelper::toArray($data, [], false);
85			#return $data;
86			}
87
88			/**
89			* Renders file content using given data.
90			* Converts to array with ArrayHelper::toArray.
91			*
92			* @param mixed $data
93			*
94			* @return string file content
95			*/
96			public function renderPath($path, $data)
97			{
98			return $this->write($path, $this->render($data));
99			}
100
101			public function parsePath($path, $minimal = null)
102			{
103			return $this->parse($this->read($path));
			0 ignored issues – show Documentation Bug introduced 2015-12-02 18:05 UTC by Report Bug Copy Issue Report The method `parse` does not exist on `object<hidev\handlers\BaseHandler>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
104			}
105
106			/**
107			* Writes given content to the file.
108			* Doesn't touch file if it has exactly same content.
109			* Creates intermediate directories when necessary.
110			* @param string $path
111			* @param string $content
112			* @return bool true if file was changed
113			*/
114			public function write($path, $content)
115			{
116			if (!is_file($path) \|\| file_get_contents($path) !== $content) {
117			$this->mkdir(dirname($path));
118			file_put_contents($path, $content);
119			Yii::warning('Written file: ' . $path, 'file');
120
121			return true;
122			}
123
124			return false;
125			}
126
127			/**
128			* Creates directory if not exists.
129			* @param string $path
130			* @return bool true if directory did not exist and was created
131			*/
132			public function mkdir($path)
133			{
134			$path = trim(trim($path), '/');
135			if (!file_exists($path)) {
136			mkdir($path, 0777, true);
137			Yii::warning('Created dir: ' . $path . '/', 'file');
138
139			return true;
140			}
141
142			return false;
143			}
144
145			public function read($path, $asArray = false)
146			{
147			if (file_exists($path)) {
148			Yii::info('Read file: ' . $path, 'file');
149
150			return $asArray ? file($path) : file_get_contents($path);
151			} else {
152			Yii::error('Couldn\'t read file: ' . $path, 'file');
153
154			return;
155			}
156			}
157
158			public function readArray($path)
159			{
160			return $this->read($path, true);
161			}
162			}
163

hiqdev / hidev

Push — master ( 9bb604...7c4aaf )

BaseHandler::mkdir() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like