hidev\controllers\FileController

Complexity

Total Complexity

26

Size/Duplication

Total Lines	212
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

60%

Importance

Changes	6
Bugs	0	Features	2

16 Methods

Rating	Name	Duplication	Size	Complexity
A	setTemplate()	0	4	1
A	getTemplate()	0	4	2
A	getFile()	0	16	4
A	setFile()	0	4	1
A	setPath()	0	4	1
A	setCopy()	0	5	1
A	getCopy()	0	4	1
A	getDirname()	0	4	1
A	getPath()	0	4	1
A	exists()	0	4	1
A	read()	0	4	1
A	readArray()	0	4	1
A	actionPerform()	0	5	1
A	actionLoad()	0	9	3
A	actionSave()	0	8	3
A	actionModify()	0	9	3

<?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\controllers;

use hidev\base\File;
use hidev\helpers\Helper;
use Yii;
use yii\helpers\ArrayHelper;

/**
 * File controller.
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class FileController extends CollectionController
{
    /**
     * {@inheritdoc}
     */
    protected $_make = ['load', 'save', 'modify'];

    /**
     * @var string specifies handler to be used.
     */
    public $fileType;

    /**
     * @var bool Don't touch file if exists.
     */
    public $once;

    /**
     * @var string Username to change file owner to.
     */
    public $chown;

    /**
     * @var string Group to change file group to.
     */
    public $chgrp;

    /**
     * @var string|integer Permissions to change to.
     */
    public $chmod;

    /**
     * @var array|File the file to be handled.
     */
    protected $_file;

    /**
     * @var string path to copy from.
     */
    protected $_copy;

    /**
     * @var string the path to the file.
     */
    protected $_path;

    /**
     * @var string the template name.
     */
    protected $_template;

    /**
     * Template setter.
     * @param string $template name.
     */
    public function setTemplate($template)
    {
        $this->_template = $template;
    }

    /**
     * Template getter.
     */
    public function getTemplate()
    {
        return Helper::file2template($this->_template ?: $this->id);
    }

    /**
     * Returns the file object.
     * Instantiates it if necessary.
     *
     * @return File
     */
    public function getFile()
    {
        if (!is_object($this->_file)) {
            $this->_file = Yii::createObject(array_merge([
                'class'    => File::className(),
                'template' => $this->getTemplate(),
                'goal'     => $this,
                'path'     => $this->_path ?: $this->id,
            ], is_string($this->_file)
                ? ['path' => $this->_file]
                : (array) $this->_file
            ));
        }

        return $this->_file;
    }

    /**
     * Sets file with given info.
     * @param mixed $info could be anything that is good for File::create
     */
    public function setFile($info)
    {
        $this->_file = $info;
    }

    /**
     * Sets the path to the file, but file info has precendence.
     * @param string $value
     */
    public function setPath($value)
    {
        $this->_path = $value;
    }

    /**
     * Copy setter. Turns this file type to `copy`.
     */
    public function setCopy($value)
    {
        $this->fileType = 'copy';
        $this->_copy = $value;
    }

    /**
     * Copy getter. Processes aliases.
     */
    public function getCopy()
    {
        return Yii::getAlias($this->_copy);
    }

    /**
     * Dirname getter.
     */
    public function getDirname()
    {
        return $this->getFile()->getDirname();
    }

    /**
     * Path getter.
     */
    public function getPath()
    {
        return $this->getFile()->getPath();
    }

    /**
     * Checks if the file exists.
     */
    public function exists()
    {
        return $this->getFile()->exists();
    }

    /**
     * Read the file.
     */
    public function read()
    {
        return $this->getFile()->read();
    }

    /**
     * Read the file into array.
     * @return array
     */
    public function readArray()
    {
        return $this->getFile()->readArray();
    }

    /**
     * {@inheritdoc}
     */
    public function actionPerform($name = null, $path = null)
    {
        Yii::trace("Started: '$this->id'");
        return $this->runActions(['before', 'make', 'after']);
    }

    public function actionLoad()
    {
        $data = $this->getFile()->load() ?: [];
        if ($data) { /// TODO think what's better
        //  $this->setItems(ArrayHelper::merge($data, $this->toArray()));

70% of this comment could be valid code. Did you maybe forget this after debugging?

            $this->setItems(ArrayHelper::merge($this->toArray(), $data));
        //  $this->setItems($data);

75% of this comment could be valid code. Did you maybe forget this after debugging?

        }
    }

    /**
     * {@inheritdoc}
     */
    public function actionSave()
    {
        if ($this->once && $this->exists()) {
            return 0;
        }
        $this->_items = Helper::uniqueConfig($this->_items);
        $this->getFile()->save($this);
    }

    /**
     * Modify action.
     */
    public function actionModify()
    {
        foreach (['chown', 'chgrp', 'chmod'] as $k) {
            $v = $this->{$k};
            if ($v) {
                $this->file->{$k}($v);

The property file does not exist on object<hidev\controllers\FileController>. Since you implemented __get, maybe consider adding a @property annotation.

            }
        }
    }
}