FieldsTrait::clearFields() - Code Metrics - Inspection of "Support for Blocks" - php-slack/slack - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

unknown

created 2020-03-03 21:43 UTC

FieldsTrait::clearFields() A

↳ Parent: FieldsTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	5
ccs	3
cts	3
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php
namespace Maknz\Slack;

use InvalidArgumentException;

trait FieldsTrait
{
    /**
     * The fields of the block/attachment.
     *
     * @var array
     */
    protected $fields = [];

    /**
     * Get the fields for the block/attachment.
     *
     * @return Field[]|array
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Set the fields for the block/attachment.
     *
     * @param array $fields
     *
     * @return $this
     *
     * @throws \InvalidArgumentException
     */
    public function setFields(array $fields)
    {
        $this->clearFields();

        foreach ($fields as $field) {
            $this->addField($field);
        }

        return $this;
    }

    /**
     * Add a field to the block/attachment.
     *
     * @param Field|array $field
     *
     * @return $this
     *
     * @throws \InvalidArgumentException
     */
    public function addField($field)
    {
        if ($field instanceof static::$fieldClass) {

            $this->fields[] = $field;

            return $this;
        } elseif (is_array($field)) {
            $this->fields[] = new static::$fieldClass($field);

            return $this;
        }

        throw new InvalidArgumentException('The field must be an instance of '.static::$fieldClass.' or a keyed array');
    }

    /**
     * Clear the fields for the block/attachment.
     *
     * @return $this
     */
    public function clearFields()
    {
        $this->fields = [];

        return $this;
    }

    /**
     * Iterates over all fields in this block/attachment and returns
     * them in their array form.
     *
     * @return array
     */
    protected function getFieldsAsArrays()
    {
        $fields = [];

        foreach ($this->getFields() as $field) {
            $fields[] = $field->toArray();
        }

        return $fields;
    }
}


1		<?php
2		namespace Maknz\Slack;
3
4		use InvalidArgumentException;
5
6		trait FieldsTrait
7		{
8		/**
9		* The fields of the block/attachment.
10		*
11		* @var array
12		*/
13		protected $fields = [];
14
15		/**
16		* Get the fields for the block/attachment.
17		*
18		* @return Field[]\|array
19		*/
20	13	public function getFields()
21		{
22	13	return $this->fields;
23		}
24
25		/**
26		* Set the fields for the block/attachment.
27		*
28		* @param array $fields
29		*
30		* @return $this
31		*
32		* @throws \InvalidArgumentException
33		*/
34	9	public function setFields(array $fields)
35		{
36	9	$this->clearFields();
37
38	9	foreach ($fields as $field) {
39	5	$this->addField($field);
40		}
41
42	9	return $this;
43		}
44
45		/**
46		* Add a field to the block/attachment.
47		*
48		* @param Field\|array $field
49		*
50		* @return $this
51		*
52		* @throws \InvalidArgumentException
53		*/
54	8	public function addField($field)
55		{
56	8	if ($field instanceof static::$fieldClass) {
		0 ignored issues – show Bug introduced 2020-03-03 20:52 UTC by Report Bug Copy Issue Report The property `fieldClass` does not exist on `Maknz\Slack\FieldsTrait`. Did you mean `fields`? Loading history...
57	2	$this->fields[] = $field;
58
59	2	return $this;
60	6	} elseif (is_array($field)) {
61	5	$this->fields[] = new static::$fieldClass($field);
62
63	5	return $this;
64		}
65
66	1	throw new InvalidArgumentException('The field must be an instance of '.static::$fieldClass.' or a keyed array');
67		}
68
69		/**
70		* Clear the fields for the block/attachment.
71		*
72		* @return $this
73		*/
74	9	public function clearFields()
75		{
76	9	$this->fields = [];
77
78	9	return $this;
79		}
80
81		/**
82		* Iterates over all fields in this block/attachment and returns
83		* them in their array form.
84		*
85		* @return array
86		*/
87	6	protected function getFieldsAsArrays()
88		{
89	6	$fields = [];
90
91	6	foreach ($this->getFields() as $field) {
92	4	$fields[] = $field->toArray();
93		}
94
95	6	return $fields;
96		}
97		}
98

php-slack / slack

Pull Request — master (#38)

FieldsTrait::clearFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like