BristolSU\ControlDB\Export\FormattedItem

Complexity

Total Complexity

13

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	3	1
A	__construct()	0	3	1
A	original()	0	3	1
A	__toString()	0	3	1
A	toJson()	0	3	1
A	preparedItems()	0	3	1
A	isType()	0	3	1
A	getColumnNames()	0	3	1
A	getItem()	0	6	3
A	create()	0	3	1
A	addRow()	0	3	1

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Export;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;

class FormattedItem implements Arrayable, Jsonable

Missing doc comment for class FormattedItem

{

    /**
     * The original item
     * 
     * @var mixed
     */
    private $original;

Private member variable "original" must be prefixed with an underscore

    /**
     * Formatted items to prepare
     * 
     * @var array
     */
    private $prepared = [];

Private member variable "prepared" must be prefixed with an underscore

    public function __construct($original)

Missing doc comment for function __construct()

    {
        $this->original = $original;
    }

    public static function create($original)

Missing doc comment for function create()

    {
        return new static($original);
    }

    public function original()

Missing doc comment for function original()

    {
        return $this->original;
    }

    public function isType(string $type)

Missing doc comment for function isType()

    {
        return $this->original() instanceof $type;
    }

    
    public function addRow($key, $value)

Missing doc comment for function addRow()

    {
        $this->prepared[$key] = $value;
    }

    public function getColumnNames()

Missing doc comment for function getColumnNames()

    {
        return array_keys($this->prepared);
    }
    
    public function getItem($column, $default = null)

Missing doc comment for function getItem()

    {
        if(array_key_exists($column, $this->prepared) && $this->prepared[$column] !== null) {

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

            return $this->prepared[$column];
        }
        return $default;
    }
    
    public function preparedItems(): array

Missing doc comment for function preparedItems()

    {
        return $this->prepared;
    }
    
    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function toArray()
    {
        return $this->preparedItems();
    }

    /**

Missing short description in doc comment

Parameter $options should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), 0);
    }

    public function __toString()

Missing doc comment for function __toString()

    {
        return $this->toJson();
    }
}