BristolSU\ControlDB\Export\Formatter\Formatter

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	config()	0	6	2
A	canHandle()	0	6	2
A	format()	0	5	2

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Export\Formatter;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Position;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\Tags\GroupTag;
use BristolSU\ControlDB\Contracts\Models\Tags\GroupTagCategory;
use BristolSU\ControlDB\Contracts\Models\Tags\PositionTag;
use BristolSU\ControlDB\Contracts\Models\Tags\PositionTagCategory;
use BristolSU\ControlDB\Contracts\Models\Tags\RoleTag;
use BristolSU\ControlDB\Contracts\Models\Tags\RoleTagCategory;
use BristolSU\ControlDB\Contracts\Models\Tags\UserTag;
use BristolSU\ControlDB\Contracts\Models\Tags\UserTagCategory;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Export\FormattedItem;

abstract class Formatter

Missing doc comment for class Formatter

{

    public const USERS = User::class;
    
    public const GROUPS = Group::class;
    
    public const ROLES = Role::class;
    
    public const POSITIONS = Position::class;
    
    public const USERTAGS = UserTag::class;

    public const GROUPTAGS = GroupTag::class;

    public const ROLETAGS = RoleTag::class;

    public const POSITIONTAGS = PositionTag::class;

    public const USERTAGCATEGORIES = UserTagCategory::class;

    public const GROUPTAGCATEGORIES = GroupTagCategory::class;

    public const ROLETAGCATEGORIES = RoleTagCategory::class;

    public const POSITIONTAGCATEGORIES = PositionTagCategory::class;
    
    public const ALL = 'all';
    /**

Missing short description in doc comment

     * @var array
     */
    protected $config;

    public function __construct(array $config)

Missing doc comment for function __construct()

    {
        $this->config = $config;
    }
    
    /**

Missing short description in doc comment

     * @param string $key

Missing parameter comment

     * @param null $default

Are you sure the doc-type for parameter $default is correct as it would always require null to be passed?

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return mixed|null
     */
    protected function config(string $key, $default = null)
    {
        if(array_key_exists($key, $this->config)) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $this->config[$key];
        }
        return $default;
    }
    
    /**

Missing short description in doc comment

     * @param array|FormattedItem[] $items Items ready to format

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function format($items)
    {
        return array_map(function($item) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return $this->canHandle($item) ? $this->formatItem($item) : $item;
        }, $items);

For multi-line function calls, the closing parenthesis should be on a new line.

    }
    
    abstract public function formatItem(FormattedItem $formattedItem): FormattedItem;

Missing doc comment for function formatItem()

    abstract public function handles(): string;

Missing doc comment for function handles()

    
    protected function canHandle(FormattedItem $item): bool

Missing doc comment for function canHandle()

    {
        if($this->handles() === self::ALL) {

Expected "if (...) {\n"; found "if(...) {\n"

            return true;
        }
        return $item->isType($this->handles());
    }

}