app\modules\admin\helpers\FileRulesTextHelper

Complexity

Total Complexity

37

Size/Duplication

Total Lines	245
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	__toString()	0	11	1
A	maxSizeDescription()	0	9	2
A	maxFilesDescription()	0	9	2
A	extensionDescription()	0	9	2
B	imageSizeDescription()	0	30	6
A	isImageStrictSize()	0	9	3
A	imageStrictSizeDescription()	0	7	1
A	isImageMinAndMaxSize()	0	4	1
A	isImageMinSize()	0	7	4
A	imageMinSizeDescription()	0	7	1
A	isImageMaxSize()	0	7	4
A	imageMaxSizeDescription()	0	7	1
B	imageRules()	0	27	7

<?php

namespace app\modules\admin\helpers;

use Yii;
use yii\helpers\ArrayHelper;

/**
 * Converting file validation rules to text
 */
class FileRulesTextHelper
{
    /**
     * @var array Validation rules
     */
    private $rules;
    /**
     * @var array Validation rules of image
     */
    private $imageSize;
    /**
     * @var string Delimiter for rules
     */
    private $delimiter = '<br>';

    /**
     * @param array $rules Validation rules
     * @param string $delimiter Delimiter for rules. Default `<br>` 
     */
    public function __construct(array $rules, $delimiter = null)
    {
        $this->rules = $rules;
        $this->imageSize = ArrayHelper::getValue($rules, 'imageSize', []);

It seems like \yii\helpers\ArrayHelper::getValue($rules, 'imageSize', array()) of type * is incompatible with the declared type array of property $imageSize.

        if ($delimiter !== null) {
            $this->delimiter = $delimiter;
        }
    }

    /**
     * Get a description of the validation rules in as text
     *
     * @return string
     */
    public function __toString()
    {
        $text = [];
        
        $text[] = $this->imageSizeDescription();
        $text[] = $this->extensionDescription();
        $text[] = $this->maxSizeDescription();
        $text[] = $this->maxFilesDescription();

        return implode($this->delimiter, array_filter($text));
    }

    /**
     * Get description for rule the `maximum size`
     * 
     * @return string|null
     */
    public function maxSizeDescription(): ?string
    {
        $rules = ArrayHelper::getValue($this->rules, 'maxSize');
        if ($rules === null) {
            return null;
        }

        return Yii::t('app', 'Max. file size') . ': ' . Yii::$app->formatter->asShortSize($rules) . ' ';
    }

    /**
     * Get description for rule the `maximum count of files`
     * 
     * @return string|null
     */
    public function maxFilesDescription(): ?string
    {
        $rules = ArrayHelper::getValue($this->rules, 'maxFiles');
        if ($rules === null) {
            return null;
        }

        return Yii::t('app', 'Max. file number') . ': ' . $rules . ' ';
    }

    /**
     * Get description for rule the `allowed extensions`
     * 
     * @return string|null
     */
    public function extensionDescription(): ?string
    {
        $rules = ArrayHelper::getValue($this->rules, 'extensions');
        if ($rules === null) {
            return null;
        }

        return Yii::t('app', 'File types') . ': ' . strtoupper(implode(', ', $rules)) . ' ';
    }

    /**
     * Get description for rule the `image sizes`
     * 
     * @return string|null
     */
    public function imageSizeDescription(): ?string
    {
        $text = [];
        switch ($this->imageSize) {
            case $this->isImageStrictSize():
                $text[] = $this->imageStrictSizeDescription();
                break;
            case $this->isImageMinAndMaxSize():
                $text[] = $this->imageMinSizeDescription();
                $text[] = $this->imageMaxSizeDescription();
                break;
            case $this->isImageMinSize():
                $text[] = $this->imageMinSizeDescription();
                $text = array_merge($text, $this->imageRules(['minWidth', 'minHeight']));
                break;
            case $this->isImageMaxSize():
                $text[] = $this->imageMaxSizeDescription();
                $text = array_merge($text, $this->imageRules(['maxWidth', 'maxHeight']));
                break;
            default:
                $text = $this->imageRules();
                break;
        }

        if (count($text)) {
            return implode($this->delimiter, array_filter($text));
        }

        return null;
    }

    /**
     * Whether the image has strict size
     * 
     * @return bool 
     */
    public function isImageStrictSize(): bool
    {
        $maxWidth  = ArrayHelper::getValue($this->imageSize, 'maxWidth');
        $minWidth  = ArrayHelper::getValue($this->imageSize, 'minWidth');
        $maxHeight = ArrayHelper::getValue($this->imageSize, 'maxHeight');
        $minHeight = ArrayHelper::getValue($this->imageSize, 'minHeight');

        return count($this->imageSize) == 4 && ($maxWidth == $minWidth && $maxHeight == $minHeight);
    }

    /**
     * Get description for image with strict size
     * 
     * @return string
     */
    public function imageStrictSizeDescription(): string
    {
        return
            Yii::t('app', 'Image size') . ': ' . 
            ArrayHelper::getValue($this->imageSize, 'maxWidth') . 'x' . 
            ArrayHelper::getValue($this->imageSize, 'maxHeight') . 'px';
    }

    /**
     * Whether the image has max and min size
     * 
     * @return bool 
     */
    public function isImageMinAndMaxSize(): bool
    {
        return count($this->imageSize) == 4;
    }

    /**
     * Whether the image has min size
     * 
     * @return bool 
     */
    public function isImageMinSize(): bool
    {
        $minWidth  = ArrayHelper::getValue($this->imageSize, 'minWidth');
        $minHeight = ArrayHelper::getValue($this->imageSize, 'minHeight');

        return (count($this->imageSize) == 2 || count($this->imageSize) == 3) && $minWidth && $minHeight;
    }

    /**
     * Get description for image with min size
     * 
     * @return string
     */
    public function imageMinSizeDescription(): string
    {
        return
            Yii::t('app', 'Min. size of image') . ': ' . 
            ArrayHelper::getValue($this->imageSize, 'minWidth') . 'x' . 
            ArrayHelper::getValue($this->imageSize, 'minHeight') . 'px';
    }

    /**
     * Whether the image has max size
     * 
     * @return bool 
     */
    public function isImageMaxSize(): bool
    {
        $maxWidth  = ArrayHelper::getValue($this->imageSize, 'maxWidth');
        $maxHeight = ArrayHelper::getValue($this->imageSize, 'maxHeight');

        return (count($this->imageSize) == 2 || count($this->imageSize) == 3) && $maxWidth && $maxHeight;
    }

    /**
     * Get description for image with max size
     * 
     * @return string
     */
    public function imageMaxSizeDescription(): string
    {
        return
            Yii::t('app', 'Max. size of image') . ': ' . 
            ArrayHelper::getValue($this->imageSize, 'maxWidth') . 'x' . 
            ArrayHelper::getValue($this->imageSize, 'maxHeight') . 'px';
    }

    private function imageRules(array $exclude = []): array
    {
        $rules = $this->imageSize;
        foreach ($exclude as $item) {
            unset($rules[$item]);
        }

        $text = [];
        foreach ($rules as $rule => $value) {
            switch ($rule) {
                case 'minWidth':
                    $text[] = Yii::t('app', 'Min. width') . ' ' . $value . 'px';
                    break;
                case 'minHeight':
                    $text[] = Yii::t('app', 'Min. height') . ' ' . $value . 'px';
                    break;
                case 'maxWidth':
                    $text[] = Yii::t('app', 'Max. width') . ' ' . $value . 'px';
                    break;
                case 'maxHeight':
                    $text[] = Yii::t('app', 'Max. height') . ' ' . $value . 'px';
                    break;
            }
        }

        return $text;
    }
}