RowTrait::hasColumn() - Code Metrics - Inspection of "Merge branch 'master' into pac-264--pdo-exception" - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — pac-264--pdo-exception ( 31f59e...68f56d )

by Tim

created 2020-12-29 16:56 UTC

RowTrait::hasColumn() A

↳ Parent: RowTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	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;

    /**
     * The number of rows that has been skipped.
     *
     * @var integer
     */
    protected $skippedRows = 0;

    /**
     * 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)
    {

        // raise the counter for the skipped rows
        if ($skip === true) {
            $this->skippedRows++;
        }

        // set the the flag to signal the row has been skipped
        $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)) {
            // load the key for the row
            $headerValue = $this->getHeader($name);

            // 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;
    }

    /**
     * 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)) {
            // load the header value
            $headerValue = $this->getHeader($name);
            // 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;
    }

    /**
     * Return's the number of skipped rows.
     *
     * @return int The number of skipped rows
     */
    public function getSkippedRows()
    {
        return $this->skippedRows;
    }

    /**
     * This method queries whether or not  the column with the passed name is available or
     * not. This  method uses the `isset()` function to make sure the column is available
     * and has not been removed somehow before, because it has an empty value for example.
     *
     * @param string $name The name of the column to query for
     *
     * @return boolean TRUE if the columen is available, FALSE otherwise
     */
    public function hasColumn(string $name) : bool
    {

        // query whether or not the header is available, if yes try
        // to load the key and query whether the column is available
        if ($this->hasHeader($name)) {
            return isset($this->row[$this->getHeader($name)]);
        }

        // return FALSE if not
        return false;
    }

    /**
     * Queries whether or not the header with the passed name is available.
     *
     * @param string $name The header name to query
     *
     * @return boolean TRUE if the header is available, else FALSE
     */
    abstract public function hasHeader($name);

    /**
     * Return's the header value for the passed name.
     *
     * @param string $name The name of the header to return the value for
     *
     * @return mixed The header value
     * @throws \InvalidArgumentException Is thrown, if the header with the passed name is NOT available
     */
    abstract public function getHeader($name);
}


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			* The number of rows that has been skipped.
51			*
52			* @var integer
53			*/
54			protected $skippedRows = 0;
55
56			/**
57			* Stop's observer execution on the actual row.
58			*
59			* @param boolean $skip The flag to skip row exection or not
60			*
61			* @return void
62			*/
63			public function skipRow($skip = true)
64			{
65
66			// raise the counter for the skipped rows
67			if ($skip === true) {
68			$this->skippedRows++;
69			}
70
71			// set the the flag to signal the row has been skipped
72			$this->skipRow = $skip;
73			}
74
75			/**
76			* Query's whether or not the observer execution for the given row has to be skipped.
77			*
78			* @return boolean TRUE if the observer execution has to be skipped, else FALSE
79			*/
80			public function rowHasToBeSkipped()
81			{
82			return $this->skipRow;
83			}
84
85			/**
86			* Set's the actual row, that has to be processed.
87			*
88			* @param array $row The row
89			*
90			* @return void
91			*/
92			public function setRow(array $row)
93			{
94			$this->row = $row;
95			}
96
97			/**
98			* Return's the actual row.
99			*
100			* @return array The actual row
101			*/
102			public function getRow()
103			{
104			return $this->row;
105			}
106
107			/**
108			* Query whether or not a value for the column with the passed name exists.
109			*
110			* @param string $name The column name to query for a valid value
111			*
112			* @return boolean TRUE if the value is set, else FALSE
113			*/
114			public function hasValue($name)
115			{
116
117			// query whether or not the header is available
118			if ($this->hasHeader($name)) {
119			// load the key for the row
120			$headerValue = $this->getHeader($name);
121
122			// query whether the rows column has a vaild value
123			return (isset($this->row[$headerValue]) && $this->row[$headerValue] !== '');
124			}
125
126			// return FALSE if not
127			return false;
128			}
129
130			/**
131			* Set the value in the passed column name.
132			*
133			* @param string $name The column name to set the value for
134			* @param mixed $value The value to set
135			*
136			* @return void
137			*/
138			protected function setValue($name, $value)
139			{
140			$this->row[$this->getHeader($name)] = $value;
141			}
142
143			/**
144			* Resolve's the value with the passed colum name from the actual row. If a callback will
145			* be passed, the callback will be invoked with the found value as parameter. If
146			* the value is NULL or empty, the default value will be returned.
147			*
148			* @param string $name The name of the column to return the value for
149			* @param mixed\|null $default The default value, that has to be returned, if the row's value is empty
150			* @param callable\|null $callback The callback that has to be invoked on the value, e. g. to format it
151			*
152			* @return mixed\|null The, almost formatted, value
153			*/
154			public function getValue($name, $default = null, callable $callback = null)
155			{
156
157			// initialize the value
158			$value = null;
159
160			// query whether or not the header is available
161			if ($this->hasHeader($name)) {
162			// load the header value
163			$headerValue = $this->getHeader($name);
164			// query wheter or not, the value with the requested key is available
165			if ((isset($this->row[$headerValue]) && $this->row[$headerValue] !== '')) {
166			$value = $this->row[$headerValue];
167			}
168			}
169
170			// query whether or not, a callback has been passed
171			if ($value != null && is_callable($callback)) {
172			$value = call_user_func($callback, $value);
173			}
174
175			// query whether or not
176			if ($value == null && $default !== null) {
177			$value = $default;
178			}
179
180			// return the value
181			return $value;
182			}
183
184			/**
185			* Return's the number of skipped rows.
186			*
187			* @return int The number of skipped rows
188			*/
189			public function getSkippedRows()
190			{
191			return $this->skippedRows;
192			}
193
194			/**
195			* This method queries whether or not the column with the passed name is available or
196			* not. This method uses the `isset()` function to make sure the column is available
197			* and has not been removed somehow before, because it has an empty value for example.
198			*
199			* @param string $name The name of the column to query for
200			*
201			* @return boolean TRUE if the columen is available, FALSE otherwise
202			*/
203			public function hasColumn(string $name) : bool
204			{
205
206			// query whether or not the header is available, if yes try
207			// to load the key and query whether the column is available
208			if ($this->hasHeader($name)) {
209			return isset($this->row[$this->getHeader($name)]);
210			}
211
212			// return FALSE if not
213			return false;
214			}
215
216			/**
217			* Queries whether or not the header with the passed name is available.
218			*
219			* @param string $name The header name to query
220			*
221			* @return boolean TRUE if the header is available, else FALSE
222			*/
223			abstract public function hasHeader($name);
224
225			/**
226			* Return's the header value for the passed name.
227			*
228			* @param string $name The name of the header to return the value for
229			*
230			* @return mixed The header value
231			* @throws \InvalidArgumentException Is thrown, if the header with the passed name is NOT available
232			*/
233			abstract public function getHeader($name);
234			}
235

techdivision / import

Push — pac-264--pdo-exception ( 31f59e...68f56d )

RowTrait::hasColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like