FieldManager::getFieldIndex() - Code Metrics - Inspection of "Remove log output" - StoutLogic/acf-builder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — develop (4c9db4)

by Steve

created 2016-07-29 12:20 UTC

FieldManager::getFieldIndex() A

↳ Parent: FieldManager

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	10
rs	9.4285
cc	3
eloc	5
nc	3
nop	1

<?php

namespace StoutLogic\AcfBuilder;

/**
 * Manages an array of field configs
 */
class FieldManager
{
    /**
     * Array of fields
     * @var array
     */
    private $fields;

    /**
     * @param array $fields optional default array of field configs
     */
    public function __construct($fields = [])
    {
        $this->fields = $fields;
    }

    /**
     * @return array[NamedBuilder] field configs

     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Return int of fields
     * @return int field count
     */
    public function getCount()
    {
        return count($this->getFields());
    }

    /**
     * Add field to end of array
     * @param  array|Builder $field Field array config or Builder
     * @return void
     */
    public function pushField($field)
    {
        $this->insertFields($field, $this->getCount());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Remove last field from end of array
     * @throws \OutOfRangeException if array is empty
     * @return array|Builder Field array config or Builder
     */
    public function popField()
    {
        if ($this->getCount() > 0) {
            $fields = $this->removeFieldAtIndex($this->getCount() - 1);
            return $fields[0];
        }

        throw new \OutOfRangeException("Can't call popField when the field count is 0");
    }

    /**
     * Insert of field at a specific index
     * @param  NamedBuilder $fields a single field or an array of fields
     * @param  int $index  insertion point
     * @return void
     */
    public function insertFields($fields, $index)
    {
        if (!$fields instanceof NamedBuilder && !is_array($fields)) {
            return;
        }

        // If a singular field config, put into an array of fields
        if ($fields instanceof NamedBuilder) {
            $fields = [$fields];
        }


        foreach ($fields as $i => $field) {
            if ($this->validateField($field)) {
                array_splice($this->fields, $index + $i, 0, [$field]);
            }
        }
    }

    /**
     * Remove a field at a specific index
     * @param  int $index
     * @return array  removed field
     */
    private function removeFieldAtIndex($index)
    {
        return array_splice($this->fields, $index, 1);
    }

    /**
     * Remove a speicifc field by name
     * @param  string $name name of the field
     * @return void
     */
    public function removeField($name)
    {
        $index = $this->getFieldIndex($name);
        $this->removeFieldAtIndex($index);
    }

    /**
     * Replace a field with a single field or array of fields
     * @param  string $name  name of field to replace
     * @param  array|Builder $field single or array of fields
     * @return void
     */
    public function replaceField($name, $field)
    {
        $index = $this->getFieldIndex($name);
        $this->removeFieldAtIndex($index);
        $this->insertFields($field, $index);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Check to see if a field name already exists
     * @param  string $name field name
     * @return bool
     */
    public function fieldNameExists($name)
    {
        try {
            $this->getFieldIndex($name);
        } catch (FieldNotFoundException $e) {
            return false;
        }

        return true;
    }

    /**
     * Return a field by name
     * @param  string $name field name
     * @return FieldBuilder
     */
    public function getField($name)
    {
        return $this->fields[$this->getFieldIndex($name)];
    }

    /**
     * Modify the configuration of a field
     * @param  string $name          field name
     * @param  array $modifications  field configuration
     * @return void
     */
    public function modifyField($name, $modifications)
    {
        $field = $this->getField($name)->updateConfig($modifications);
        $this->replaceField($name, $field);
    }

    /**
     * Validate a field
     * @param  NamedBuilder $field
     * @return bool
     */
    private function validateField($field)
    {
        return $this->validateFieldName($field);
    }

    /**
     * Validates that a field's name doesn't already exist
     * @param  NamedBuilder $field
     * @throws FieldNameCollisionException when the name already exists
     * @return bool
     */
    private function validateFieldName($field)
    {
        $fieldName = $field->getName();
        if (!$fieldName || $this->fieldNameExists($fieldName)) {
            throw new FieldNameCollisionException("Field Name: `{$fieldName}` already exists.");
        }

        return true;
    }

    /**
     * Return the index in the $this->fields array looked up by the field's name
     * @param  string $name Field Name
     * @throws FieldNotFoundException if the field name doesn't exist
     * @return int Field Index
     */
    public function getFieldIndex($name)
    {
        foreach ($this->getFields() as $index => $field) {
            if ($field->getName() === $name) {
                return $index;
            }
        }

        throw new FieldNotFoundException("Field `{$name}` not found.");
    }
}


1			<?php
2
3			namespace StoutLogic\AcfBuilder;
4
5			/**
6			* Manages an array of field configs
7			*/
8			class FieldManager
9			{
10			/**
11			* Array of fields
12			* @var array
13			*/
14			private $fields;
15
16			/**
17			* @param array $fields optional default array of field configs
18			*/
19			public function __construct($fields = [])
20			{
21			$this->fields = $fields;
22			}
23
24			/**
25			* @return array[NamedBuilder] field configs
			0 ignored issues – show Documentation introduced 2016-07-29 12:47 UTC by Report Bug Copy Issue Report The doc-type `array[NamedBuilder]` could not be parsed: Expected "]" at position 2, but found "NamedBuilder". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
26			*/
27			public function getFields()
28			{
29			return $this->fields;
30			}
31
32			/**
33			* Return int of fields
34			* @return int field count
35			*/
36			public function getCount()
37			{
38			return count($this->getFields());
39			}
40
41			/**
42			* Add field to end of array
43			* @param array\|Builder $field Field array config or Builder
44			* @return void
45			*/
46			public function pushField($field)
47			{
48			$this->insertFields($field, $this->getCount());
			0 ignored issues – show Documentation introduced 2016-07-29 12:47 UTC by Report Bug Copy Issue Report `$field` is of type `array\|object<StoutLogic\AcfBuilder\Builder>`, but the function expects a `object<StoutLogic\AcfBuilder\NamedBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
49			}
50
51			/**
52			* Remove last field from end of array
53			* @throws \OutOfRangeException if array is empty
54			* @return array\|Builder Field array config or Builder
55			*/
56			public function popField()
57			{
58			if ($this->getCount() > 0) {
59			$fields = $this->removeFieldAtIndex($this->getCount() - 1);
60			return $fields[0];
61			}
62
63			throw new \OutOfRangeException("Can't call popField when the field count is 0");
64			}
65
66			/**
67			* Insert of field at a specific index
68			* @param NamedBuilder $fields a single field or an array of fields
69			* @param int $index insertion point
70			* @return void
71			*/
72			public function insertFields($fields, $index)
73			{
74			if (!$fields instanceof NamedBuilder && !is_array($fields)) {
75			return;
76			}
77
78			// If a singular field config, put into an array of fields
79			if ($fields instanceof NamedBuilder) {
80			$fields = [$fields];
81			}
82
83
84			foreach ($fields as $i => $field) {
85			if ($this->validateField($field)) {
86			array_splice($this->fields, $index + $i, 0, [$field]);
87			}
88			}
89			}
90
91			/**
92			* Remove a field at a specific index
93			* @param int $index
94			* @return array removed field
95			*/
96			private function removeFieldAtIndex($index)
97			{
98			return array_splice($this->fields, $index, 1);
99			}
100
101			/**
102			* Remove a speicifc field by name
103			* @param string $name name of the field
104			* @return void
105			*/
106			public function removeField($name)
107			{
108			$index = $this->getFieldIndex($name);
109			$this->removeFieldAtIndex($index);
110			}
111
112			/**
113			* Replace a field with a single field or array of fields
114			* @param string $name name of field to replace
115			* @param array\|Builder $field single or array of fields
116			* @return void
117			*/
118			public function replaceField($name, $field)
119			{
120			$index = $this->getFieldIndex($name);
121			$this->removeFieldAtIndex($index);
122			$this->insertFields($field, $index);
			0 ignored issues – show Documentation introduced 2016-07-29 12:47 UTC by Report Bug Copy Issue Report `$field` is of type `array\|object<StoutLogic\AcfBuilder\Builder>`, but the function expects a `object<StoutLogic\AcfBuilder\NamedBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
123			}
124
125			/**
126			* Check to see if a field name already exists
127			* @param string $name field name
128			* @return bool
129			*/
130			public function fieldNameExists($name)
131			{
132			try {
133			$this->getFieldIndex($name);
134			} catch (FieldNotFoundException $e) {
135			return false;
136			}
137
138			return true;
139			}
140
141			/**
142			* Return a field by name
143			* @param string $name field name
144			* @return FieldBuilder
145			*/
146			public function getField($name)
147			{
148			return $this->fields[$this->getFieldIndex($name)];
149			}
150
151			/**
152			* Modify the configuration of a field
153			* @param string $name field name
154			* @param array $modifications field configuration
155			* @return void
156			*/
157			public function modifyField($name, $modifications)
158			{
159			$field = $this->getField($name)->updateConfig($modifications);
160			$this->replaceField($name, $field);
161			}
162
163			/**
164			* Validate a field
165			* @param NamedBuilder $field
166			* @return bool
167			*/
168			private function validateField($field)
169			{
170			return $this->validateFieldName($field);
171			}
172
173			/**
174			* Validates that a field's name doesn't already exist
175			* @param NamedBuilder $field
176			* @throws FieldNameCollisionException when the name already exists
177			* @return bool
178			*/
179			private function validateFieldName($field)
180			{
181			$fieldName = $field->getName();
182			if (!$fieldName \|\| $this->fieldNameExists($fieldName)) {
183			throw new FieldNameCollisionException("Field Name: `{$fieldName}` already exists.");
184			}
185
186			return true;
187			}
188
189			/**
190			* Return the index in the $this->fields array looked up by the field's name
191			* @param string $name Field Name
192			* @throws FieldNotFoundException if the field name doesn't exist
193			* @return int Field Index
194			*/
195			public function getFieldIndex($name)
196			{
197			foreach ($this->getFields() as $index => $field) {
198			if ($field->getName() === $name) {
199			return $index;
200			}
201			}
202
203			throw new FieldNotFoundException("Field `{$name}` not found.");
204			}
205			}
206

StoutLogic / acf-builder

Branch — develop (4c9db4)

FieldManager::getFieldIndex() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like