RowTrait::skipRow() - Code Metrics - Inspection of "Fixed issue in CommandNames::isCommandName() metho..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x ( 824af6 )

by Tim

created 2019-05-02 18:35 UTC

RowTrait::skipRow() A

↳ Parent: RowTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

/**
 * TechDivision\Import\RowTrait
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import;

/**
 * A trait that provides row handling.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */
trait RowTrait
{

    /**
     * The actual row, that has to be processed.
     *
     * @var array
     */
    protected $row = array();

    /**
     * The flag that stop's overserver execution on the actual row.
     *
     * @var boolean
     */
    protected $skipRow = false;

    /**
     * Stop's observer execution on the actual row.
     *
     * @param boolean $skip The flag to skip row exection or not
     *
     * @return void
     */
    public function skipRow($skip = true)
    {
        $this->skipRow = $skip;
    }

    /**
     * Query's whether or not the observer execution for the given row has to be skipped.
     *
     * @return boolean TRUE if the observer execution has to be skipped, else FALSE
     */
    public function rowHasToBeSkipped()
    {
        return $this->skipRow;
    }

    /**
     * Set's the actual row, that has to be processed.
     *
     * @param array $row The row
     *
     * @return void
     */
    public function setRow(array $row)
    {
        $this->row = $row;
    }

    /**
     * Return's the actual row.
     *
     * @return array The actual row
     */
    public function getRow()
    {
        return $this->row;
    }

    /**
     * Query whether or not a value for the column with the passed name exists.
     *
     * @param string $name The column name to query for a valid value
     *
     * @return boolean TRUE if the value is set, else FALSE
     */
    public function hasValue($name)
    {

        // query whether or not the header is available
        if ($this->hasHeader($name)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            // load the key for the row
            $headerValue = $this->getHeader($name);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            // query whether the rows column has a vaild value
            return (isset($this->row[$headerValue]) && $this->row[$headerValue] !== '');
        }

        // return FALSE if not
        return false;
    }

    /**
     * Set the value in the passed column name.
     *
     * @param string $name  The column name to set the value for
     * @param mixed  $value The value to set
     *
     * @return void
     */
    protected function setValue($name, $value)
    {
        $this->row[$this->getHeader($name)] = $value;
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Resolve's the value with the passed colum name from the actual row. If a callback will
     * be passed, the callback will be invoked with the found value as parameter. If
     * the value is NULL or empty, the default value will be returned.
     *
     * @param string        $name     The name of the column to return the value for
     * @param mixed|null    $default  The default value, that has to be returned, if the row's value is empty
     * @param callable|null $callback The callback that has to be invoked on the value, e. g. to format it
     *
     * @return mixed|null The, almost formatted, value
     */
    public function getValue($name, $default = null, callable $callback = null)
    {

        // initialize the value
        $value = null;

        // query whether or not the header is available
        if ($this->hasHeader($name)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            // load the header value
            $headerValue = $this->getHeader($name);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            // query wheter or not, the value with the requested key is available
            if ((isset($this->row[$headerValue]) && $this->row[$headerValue] !== '')) {
                $value = $this->row[$headerValue];
            }
        }

        // query whether or not, a callback has been passed
        if ($value != null && is_callable($callback)) {
            $value = call_user_func($callback, $value);
        }

        // query whether or not
        if ($value == null && $default !== null) {
            $value = $default;
        }

        // return the value
        return $value;
    }
}


1		<?php
2
3		/**
4		* TechDivision\Import\RowTrait
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Tim Wagner <[email protected]>
15		* @copyright 2016 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link https://github.com/techdivision/import
18		* @link http://www.techdivision.com
19		*/
20
21		namespace TechDivision\Import;
22
23		/**
24		* A trait that provides row handling.
25		*
26		* @author Tim Wagner <[email protected]>
27		* @copyright 2016 TechDivision GmbH <[email protected]>
28		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
29		* @link https://github.com/techdivision/import
30		* @link http://www.techdivision.com
31		*/
32		trait RowTrait
33		{
34
35		/**
36		* The actual row, that has to be processed.
37		*
38		* @var array
39		*/
40		protected $row = array();
41
42		/**
43		* The flag that stop's overserver execution on the actual row.
44		*
45		* @var boolean
46		*/
47		protected $skipRow = false;
48
49		/**
50		* Stop's observer execution on the actual row.
51		*
52		* @param boolean $skip The flag to skip row exection or not
53		*
54		* @return void
55		*/
56	1	public function skipRow($skip = true)
57		{
58	1	$this->skipRow = $skip;
59	1	}
60
61		/**
62		* Query's whether or not the observer execution for the given row has to be skipped.
63		*
64		* @return boolean TRUE if the observer execution has to be skipped, else FALSE
65		*/
66		public function rowHasToBeSkipped()
67		{
68		return $this->skipRow;
69		}
70
71		/**
72		* Set's the actual row, that has to be processed.
73		*
74		* @param array $row The row
75		*
76		* @return void
77		*/
78	10	public function setRow(array $row)
79		{
80	10	$this->row = $row;
81	10	}
82
83		/**
84		* Return's the actual row.
85		*
86		* @return array The actual row
87		*/
88	14	public function getRow()
89		{
90	14	return $this->row;
91		}
92
93		/**
94		* Query whether or not a value for the column with the passed name exists.
95		*
96		* @param string $name The column name to query for a valid value
97		*
98		* @return boolean TRUE if the value is set, else FALSE
99		*/
100	2	public function hasValue($name)
101		{
102
103		// query whether or not the header is available
104	2	if ($this->hasHeader($name)) {
		0 ignored issues – show Bug introduced 2017-07-12 17:45 UTC by Report Bug Copy Issue Report It seems like `hasHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
105		// load the key for the row
106	1	$headerValue = $this->getHeader($name);
		0 ignored issues – show Bug introduced 2017-07-12 17:45 UTC by Report Bug Copy Issue Report It seems like `getHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
107
108		// query whether the rows column has a vaild value
109	1	return (isset($this->row[$headerValue]) && $this->row[$headerValue] !== '');
110		}
111
112		// return FALSE if not
113	1	return false;
114		}
115
116		/**
117		* Set the value in the passed column name.
118		*
119		* @param string $name The column name to set the value for
120		* @param mixed $value The value to set
121		*
122		* @return void
123		*/
124	4	protected function setValue($name, $value)
125		{
126	4	$this->row[$this->getHeader($name)] = $value;
		0 ignored issues – show Bug introduced 2017-07-12 17:45 UTC by Report Bug Copy Issue Report It seems like `getHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
127	4	}
128
129		/**
130		* Resolve's the value with the passed colum name from the actual row. If a callback will
131		* be passed, the callback will be invoked with the found value as parameter. If
132		* the value is NULL or empty, the default value will be returned.
133		*
134		* @param string $name The name of the column to return the value for
135		* @param mixed\|null $default The default value, that has to be returned, if the row's value is empty
136		* @param callable\|null $callback The callback that has to be invoked on the value, e. g. to format it
137		*
138		* @return mixed\|null The, almost formatted, value
139		*/
140	15	public function getValue($name, $default = null, callable $callback = null)
141		{
142
143		// initialize the value
144	15	$value = null;
145
146		// query whether or not the header is available
147	15	if ($this->hasHeader($name)) {
		0 ignored issues – show Bug introduced 2017-07-12 17:45 UTC by Report Bug Copy Issue Report It seems like `hasHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
148		// load the header value
149	7	$headerValue = $this->getHeader($name);
		0 ignored issues – show Bug introduced 2017-07-12 17:45 UTC by Report Bug Copy Issue Report It seems like `getHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
150		// query wheter or not, the value with the requested key is available
151	7	if ((isset($this->row[$headerValue]) && $this->row[$headerValue] !== '')) {
152	7	$value = $this->row[$headerValue];
153		}
154		}
155
156		// query whether or not, a callback has been passed
157	15	if ($value != null && is_callable($callback)) {
158	1	$value = call_user_func($callback, $value);
159		}
160
161		// query whether or not
162	15	if ($value == null && $default !== null) {
163	1	$value = $default;
164		}
165
166		// return the value
167	15	return $value;
168		}
169		}
170

techdivision / import

Push — 8.x ( 824af6 )

RowTrait::skipRow() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like