FileWidget - Code Metrics - nook-ru/digitalwand.admin_helper - Measure and Improve Code Quality continuously with Scrutinizer

FileWidget C
last analyzed 2017-03-14 19:11 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	369
Duplicated Lines	10.57 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	39
loc	369
rs	5.6163
c	2
b	0
f	0
wmc	70
lcom	1
cbo	7

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	getEditHtml()	0	39	6
B	getMultipleEditHtml()	0	61	8
A	generateRow()	0	18	3
A	showFilterHtml()	0	4	1
D	processEditAction()	17	130	41
C	saveFile()	0	41	8
A	getValueReadonly()	11	11	1
A	getMultipleValueReadonly()	11	11	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like FileWidget often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use FileWidget, and based on these observations, apply Extract Interface, too.

<?php

namespace DigitalWand\AdminHelper\Widget;

use Bitrix\Main\Localization\Loc;
use Bitrix\Main\UI\FileInput;

/**
 * Для множественного поля в таблице должен быть столбец FILE_ID.
 * Настройки класса:
 * <ul>
 * <li><b>DESCRIPTION_FIELD</b> - bool нужно ли поле описания</li>
 * <li><b>MULTIPLE</b> - bool является ли поле множественным</li>
 * <li><b>IMAGE</b> - bool отображать ли изображение файла, для старого вида отображения</li>
 * </ul>
 */
class FileWidget extends HelperWidget
{
    protected static $defaults = array(
        'IMAGE' => false,
        'DESCRIPTION_FIELD' => false,
        'EDIT_IN_LIST' => false,
        'FILTER' => false,
        'UPLOAD' => true,
        'MEDIALIB' => true,
        'FILE_DIALOG' => true,
        'CLOUD' => true,
        'DELETE' => true,
        'EDIT' => true,
    );

    /**
     * {@inheritdoc}
     */
    public function __construct(array $settings = array())
    {
        Loc::loadMessages(__FILE__);
        
        parent::__construct($settings);
    }

    /**
     * {@inheritdoc}
     */
    protected function getEditHtml()
    {
        if (class_exists('\Bitrix\Main\UI\FileInput', true) && $this->getSettings('IMAGE') === true) {
            $html = FileInput::createInstance(array(
                'name' => $this->getEditInputName('_FILE'),
                'description' => $this->getSettings('DESCRIPTION_FIELD'),
                'upload' => $this->getSettings('UPLOAD'),
                'allowUpload' => 'I',
                'medialib' => $this->getSettings('MEDIALIB'),
                'fileDialog' => $this->getSettings('FILE_DIALOG'),
                'cloud' => $this->getSettings('CLOUD'),
                'delete' => $this->getSettings('DELETE'),
                'edit' => $this->getSettings('EDIT'),
                'maxCount' => 1
            ))->show($this->getValue());
        } else {
            $html = \CFileInput::Show($this->getEditInputName('_FILE'), ($this->getValue() > 0 ? $this->getValue() : 0),
                array(
                    'IMAGE' => $this->getSettings('IMAGE') === true ? 'Y' : 'N',
                    'PATH' => 'Y',
                    'FILE_SIZE' => 'Y',
                    'ALLOW_UPLOAD' => 'I',
                ), array(
                    'upload' => $this->getSettings('UPLOAD'),
                    'medialib' => $this->getSettings('MEDIALIB'),
                    'file_dialog' => $this->getSettings('FILE_DIALOG'),
                    'cloud' => $this->getSettings('CLOUD'),
                    'del' => $this->getSettings('DELETE'),
                    'description' => $this->getSettings('DESCRIPTION_FIELD'),
                )
            );
        }

        if ($this->getValue()) {
            $html .= '<input type="hidden" name="' . $this->getEditInputName() . '" value=' . $this->getValue() . '>';
        }

        return $html;
    }

    /**
     * {@inheritdoc}
     */
    protected function getMultipleEditHtml()
    {
        $inputHidden = array();
        $inputName = array();
        
        if (!empty($this->data['ID'])) {
            $entityName = $this->entityName;
            
            $rsEntityData = $entityName::getList(array(
                'select' => array('REFERENCE_' => $this->getCode() . '.*'),
                'filter' => array('=ID' => $this->data['ID'])
            ));

            while ($referenceData = $rsEntityData->fetch()) {
                $inputName[$this->code . '[' . $referenceData['REFERENCE_ID'] . ']'] = $referenceData['REFERENCE_VALUE'];
                $inputHidden[$referenceData['REFERENCE_ID']] = $referenceData['REFERENCE_VALUE'];
            }
        }

        if (class_exists('\Bitrix\Main\UI\FileInput', true) && $this->getSettings('IMAGE') === true) {
            $html = \Bitrix\Main\UI\FileInput::createInstance(array(
                'name' => $this->code . '[n#IND#]',
                'description' => $this->getSettings('DESCRIPTION_FIELD'),
                'upload' => $this->getSettings('UPLOAD'),
                'allowUpload' => 'I',
                'medialib' => $this->getSettings('MEDIALIB'),
                'fileDialog' => $this->getSettings('FILE_DIALOG'),
                'cloud' => $this->getSettings('CLOUD'),
                'delete' => $this->getSettings('DELETE'),
                'edit' => $this->getSettings('EDIT')
            ))->show($inputName);
        } else {
            $html = \CFileInput::ShowMultiple($inputName, $this->code . '[n#IND#]',
                array(
                    'IMAGE' => $this->getSettings('IMAGE') === true ? 'Y' : 'N',
                    'PATH' => 'Y',
                    'FILE_SIZE' => 'Y',
                    'DIMENSIONS' => 'Y',
                    'IMAGE_POPUP' => 'Y',
                ), 
                false, 
                array(
                    'upload' => $this->getSettings('UPLOAD'),
                    'medialib' => $this->getSettings('MEDIALIB'),
                    'file_dialog' => $this->getSettings('FILE_DIALOG'),
                    'cloud' => $this->getSettings('CLOUD'),
                    'del' => $this->getSettings('DELETE'),
                    'description' => $this->getSettings('DESCRIPTION_FIELD'),
                )
            );
        }

        foreach ($inputHidden as $key => $input) {
            if (!empty($input)) {
                $html .= '<input type="hidden" name="' . $this->code . '[' . $key . '][ID]" value=' . $key . '>
					<input type="hidden" name="' . $this->code . '[' . $key . '][VALUE]" value=' . $input . '>';
            }
        }

        return $html;
    }

    /**
     * {@inheritdoc}
     */
    public function generateRow(&$row, $data)
    {
        $html = '';
        
        if ($this->getSettings('MULTIPLE')) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            
        } else {
            $path = \CFile::GetPath($data[$this->code]);
            $rsFile = \CFile::GetByID($data[$this->code]);
            $file = $rsFile->Fetch();

            if ($path) {
                $html = '<a href="' . $path . '" >' . $file['FILE_NAME'] . ' (' . $file['FILE_DESCRIPTION'] . ')' . '</a>';
            }
            
            $row->AddViewField($this->code, $html);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function showFilterHtml()
    {
        // TODO: Implement genFilterHTML() method.
    }

    /**
     * {@inheritdoc}
     */
    public function processEditAction()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($this->getSettings('MULTIPLE')) {
            if ($this->getSettings('READONLY') === true) {
                //удаляем все добавленные файлы в режиме только для чтения
                foreach ($this->data[$this->code] as $key => $value) {
                    if (!is_array($value)) {
                        unset($this->data[$this->code][$key]);
                    }
                }
                return false;
            }

            if (class_exists('\Bitrix\Main\UI\FileInput', true) && $this->getSettings('IMAGE') === true) {
                foreach ($this->data[$this->code] as $key => $value) {
                    if (is_array($value) && ($value['name'] || $value['tmp_name'])) {
                        $_FILES[$this->code]['name'][$key] = $value['name'];
                        $_FILES[$this->code]['type'][$key] = $value['type'];
                        $_FILES[$this->code]['tmp_name'][$key] = $value['tmp_name'];
                        $_FILES[$this->code]['error'][$key] = $value['error'];
                        $_FILES[$this->code]['size'][$key] = $value['size'];
                        unset($this->data[$this->code][$key]);
                    } else {
                        $_FILES[$this->code]['name'][$key] = '';
                    }
                }
                if (!count($this->data[$this->code])) {
                    unset($this->data[$this->code]);
                }
            }

            if (!empty($_FILES[$this->getCode()])) {
                foreach ($_FILES[$this->getCode()]['name'] as $key => $fileName) {
                    if (empty($fileName)
                        || empty($_FILES[$this->getCode()]['tmp_name'][$key])
                        || !empty($_FILES[$this->getCode()]['error'][$key])
                    ) {
                        if (isset($_REQUEST[$this->getCode() . '_del'][$key])) {
                            if (is_array($this->data[$this->getCode()][$key]) &&

                                !empty($this->data[$this->getCode()][$key]['VALUE'])
                            ) {
                                \CFile::Delete(intval($this->data[$this->getCode()][$key]['VALUE']));
                            } else {
                                \CFile::Delete(intval($this->data[$this->getCode()][$key]));
                            }
                            unset($this->data[$this->getCode()][$key]);
                        } elseif ($this->data[$this->getCode()][$key]['VALUE']) {
                            \CFile::UpdateDesc($this->data[$this->getCode()][$key]['VALUE'],
                                $_REQUEST[$this->getCode() . '_descr'][$key]);
                        }
                        continue;
                    } elseif (is_int($key)) {

                        //Удаляем старый файл при замене
                        if (is_array($this->data[$this->getCode()][$key]) &&
                            !empty($this->data[$this->getCode()][$key]['VALUE'])
                        ) {
                            \CFile::Delete(intval($this->data[$this->getCode()][$key]['VALUE']));
                        } else {
                            \CFile::Delete(intval($this->data[$this->getCode()][$key]));
                        }
                    }

                    $description = null;

                    if (isset($_REQUEST[$this->getCode() . '_descr'][$key])) {
                        $description = $_REQUEST[$this->getCode() . '_descr'][$key];
                    }

                    if (empty($this->data[$this->getCode()][$key])) {
                        unset($this->data[$this->getCode()][$key]);
                    }

                    $fileId = $this->saveFile($fileName, $_FILES[$this->getCode()]['tmp_name'][$key], false, $description);

                    if ($fileId) {
                        $this->data[$this->getCode()][$key] = array('VALUE' => $fileId);
                    } else {
                        $this->addError('DIGITALWAND_AH_FAIL_ADD_FILE', array(
                            'FILE_NAME' => $_FILES[$this->getCode()]['name'][$key]
                        ));
                    }
                }
            }
        } else {
            if (class_exists('\Bitrix\Main\UI\FileInput', true) && $this->getSettings('IMAGE') === true) {
                if (is_array($this->data[$this->code . '_FILE']) && ($this->data[$this->code . '_FILE']['name'] ||
                        $this->data[$this->code . '_FILE']['tmp_name'])
                ) {
                    $_FILES['FIELDS']['name'][$this->code . '_FILE'] = $this->data[$this->code . '_FILE']['name'];
                    $_FILES['FIELDS']['type'][$this->code . '_FILE'] = $this->data[$this->code . '_FILE']['type'];
                    $_FILES['FIELDS']['tmp_name'][$this->code . '_FILE'] = $this->data[$this->code . '_FILE']['tmp_name'];
                    $_FILES['FIELDS']['error'][$this->code . '_FILE'] = $this->data[$this->code . '_FILE']['error'];
                    $_FILES['FIELDS']['size'][$this->code . '_FILE'] = $this->data[$this->code . '_FILE']['size'];
                }
            }

            unset($this->data[$this->code . '_FILE']);
            
            if ($this->getSettings('READONLY') === true) {
                return false;
            }

            if (empty($_FILES['FIELDS']['name'][$this->code . '_FILE'])
                || empty($_FILES['FIELDS']['tmp_name'][$this->code . '_FILE'])
                || !empty($_FILES['FIELDS']['error'][$this->code . '_FILE'])
            ) {
                if (isset($_REQUEST['FIELDS_del'][$this->code . '_FILE']) AND $_REQUEST['FIELDS_del'][$this->code . '_FILE'] == 'Y') {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                    \CFile::Delete(intval($this->data[$this->code]));
                    $this->data[$this->code] = 0;
                } elseif ($this->data[$this->code] && isset($_REQUEST['FIELDS_descr'][$this->code . '_FILE'])) {
                    \CFile::UpdateDesc($this->data[$this->code],
                        $_REQUEST['FIELDS_descr'][$this->code . '_FILE']);
                }
                return false;
            }

            $description = null;

            if (isset($_REQUEST['FIELDS_descr'][$this->code . '_FILE'])) {
                $description = $_REQUEST['FIELDS_descr'][$this->code . '_FILE'];
            }

            $name = $_FILES['FIELDS']['name'][$this->code . '_FILE'];
            $path = $_FILES['FIELDS']['tmp_name'][$this->code . '_FILE'];
            $type = $_FILES['FIELDS']['type'][$this->code . '_FILE'];

            $this->saveFile($name, $path, $type, $description);
        }
        parent::processEditAction();
    }

    protected function saveFile($name, $path, $type = false, $description = null)
    {
        if (!$path) {
            return false;
        }

        $file = \CFile::MakeFileArray($path, $type);

        if (!$file) {
            return false;
        }

        if (!empty($description)) {
            $file['description'] = $description;
        }

        if ($this->getSettings('IMAGE') === true && stripos($file['type'], "image") === false) {
            $this->addError('FILE_FIELD_TYPE_ERROR');

            return false;
        }

        $file['name'] = $name;

        $moduleId = $this->helper->getModule();
        $file['MODULE_ID'] = $moduleId;

        $fileId = \CFile::SaveFile($file, $moduleId);

        if (!$this->getSettings('MULTIPLE')) {
            $code = $this->code;
            
            if (isset($this->data[$code])) {
                \CFile::Delete($this->data[$code]);
            }

            $this->data[$code] = $fileId;
        }

        return $fileId;
    }

    /**
     * {@inheritdoc}
     */
    protected function getValueReadonly()

    {
        $this->setSetting('UPLOAD', false);
        $this->setSetting('MEDIALIB', false);
        $this->setSetting('FILE_DIALOG', false);
        $this->setSetting('CLOUD', false);
        $this->setSetting('DELETE', false);
        $this->setSetting('EDIT', false);

        return $this->getEditHtml();
    }

    /**
     * {@inheritdoc}
     */
    protected function getMultipleValueReadonly()

    {
        $this->setSetting('UPLOAD', false);
        $this->setSetting('MEDIALIB', false);
        $this->setSetting('FILE_DIALOG', false);
        $this->setSetting('CLOUD', false);
        $this->setSetting('DELETE', false);
        $this->setSetting('EDIT', false);

        return $this->getMultipleEditHtml();
    }
}

nook-ru / digitalwand.admin_helper

FileWidget C last analyzed 2017-03-14 19:11 UTC