DataBaseModel::throwDataEmptyException() - Code Metrics - Inspection of "remove unnessary exception" - andela-araimi/potato-orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 97890f...06ab37 )

by Adeola

created 2016-03-22 21:39 UTC

DataBaseModel::throwDataEmptyException() A

↳ Parent: DataBaseModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/**
 * Class DataBaseModel:
 * This is an abstract class which stands as a model
 * to another class e.g User class which can inherit from
 * all its methods. This class stands as a middle man
 * between the User class and the DataBaseQuery class.
 *
 * @author: Raimi Ademola <[email protected]>
 * @copyright: 2016 Andela
 */
namespace Demo;

use Doctrine\Common\Inflector\Inflector;

abstract class DataBaseModel implements DataBaseModelInterface
{
    protected $tableName;
    protected $dbConn;
    protected $dataBaseQuery;
    protected $properties;
    protected $arrayField;

    /**
     * This is a constructor; a default method  that will be called automatically during class instantiation.
     */
    public function __construct($dbConn)
    {
        $this->tableName = self::getClassName();
        $this->dataBaseQuery = new DataBaseQuery($dbConn);
        $this->arrayField['id'] = 0;
    }

    /**
     * The magic setter method.
     *
     * @param $properties
     * @param $values
     *
     * @return array associative array properties
     */
    public function __set($properties, $values)
    {
        $this->arrayField[$properties] = $values;
    }

    /**
     * The magic getter method.
     *
     * @param $properties
     *
     * @return array key
     */
    public function __get($properties)
    {
        return $this->arrayField[$properties];
    }

    /**
     * This method gets all the record from a particular table
     * by accessing the read method from the DataBaseQuery class.
     *
     *
     * @return associative array
     */
    public static function getAll($dbConn)
    {
        $sqlData = DataBaseQuery::read($id = false, self::getClassName(), $dbConn);

        if (count($sqlData) > 0) {
            return $sqlData;
        }

        self::throwNoDataFoundException();
    }

    public static function throwNoDataFoundException()
    {
        $message = "oops, no data found in the database";
        throw new NoDataFoundException($message);
    }
            
    /**
     * This method either create or update record in a database table
     * by calling either the read method or create method in the
     * DataBaseQuery class.
     *
     * @throws NoRecordUpdateException
     * @throws EmptyArrayException
     * @throws NoRecordCreatedException
     *
     * @return bool true or false;
     */
    public function save($dbConn)
    {
        if ($this->arrayField['id']) {
            $sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName(), $dbConn);

            if ($this->checkIfRecordIsEmpty($sqlData)) {
                $boolCommit = $this->dataBaseQuery->update(['id' => $this->arrayField['id']], $this->arrayField, self::getClassName(), $dbConn);
    
                if ($boolCommit) {
                    return true;
                }

                $this->throwNoRecordUpdatedException();
            }

            $this->throwEmptyArrayException();
        } else {

            $boolCommit = $this->dataBaseQuery->create($this->arrayField, self::getClassName(), $dbConn);

            if ($boolCommit) {

                return true;
            }

            $this->throwNoRecordCreatedException();
        }
   
    }

    public function throwNoRecordUpdatedException()
    {
        $message = "oops, your record did not update succesfully";
        throw new NoRecordUpdatedException($message);
    }

    public function throwEmptyArrayException()
    {
        $message = "data passed didn't match any record";
        throw new EmptyArrayException($message);
    }

    public function throwNoRecordCreatedException()
    {
        $message = "oops,your record did not create succesfully";
        throw new NoRecordCreatedException($message);
    }

    /**
     * This method find a record by id.
     *
     * @param $id
     *
     * @throws ArgumentNumberIncorrectException
     * @throws ArgumentNotFoundException
     *
     * @return object
     */
    public static function findById($id)
    {
        $numArgs = func_num_args();

        if ($numArgs > 1) {
            throw new ArgumentNumberIncorrectException('Please input just one Argument');
        }

        if ($id == '') {
            throw new ArgumentNotFoundException('No Argument found, please input an argument');
        }

        $staticFindInstance = new static();


        $staticFindInstance->id = $id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $staticFindInstance;
    }

    /**
     * This method find a record by id and returns
     * all the data present in the id.
     *
     *
     * @return associative array
     */
    public function getById()
    {
        if ($this->arrayField['id']) {
            $sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName(), $dbConn);

            
                return $sqlData;
        }
    }

    /**
     * This method delete a row from the table by the row id.
     *
     * @param $id
     *
     * @throws ArgumentNumberIncorrectException;
     * @throws ArgumentNotFoundException;
     *
     * @return bool true
     */
    public static function destroy($id, $dbConn)
    {
        $numArgs = func_num_args();
        if ($numArgs > 2) {
            throw new ArgumentNumberIncorrectException('Please input just one Argument');
        }

        if ($numArgs == ' ') {
            throw new ArgumentNotFoundException('No Argument found, please input an argument');
        }

        DataBaseQuery::delete($id, self::getClassName(), $dbConn);
        
        return true;
    }

    public static function getClassName()
    {
        $tableName = explode('\\', get_called_class());
        
        return Inflector::pluralize(strtolower(end($tableName)));
    }

    /**
     * This method check if the argument passed to this function is an array.
     *
     * @param $arrayOfRecord
     *
     * @return bool true
     */
    public function checkIfRecordIsEmpty($arrayOfRecord)
    {
        if (count($arrayOfRecord) > 0) {
            return true;
        }

        return false;
    }
}


1		<?php
2
3		/**
4		* Class DataBaseModel:
5		* This is an abstract class which stands as a model
6		* to another class e.g User class which can inherit from
7		* all its methods. This class stands as a middle man
8		* between the User class and the DataBaseQuery class.
9		*
10		* @author: Raimi Ademola <[email protected]>
11		* @copyright: 2016 Andela
12		*/
13		namespace Demo;
14
15		use Doctrine\Common\Inflector\Inflector;
16
17		abstract class DataBaseModel implements DataBaseModelInterface
18		{
19		protected $tableName;
20		protected $dbConn;
21		protected $dataBaseQuery;
22		protected $properties;
23		protected $arrayField;
24
25		/**
26		* This is a constructor; a default method that will be called automatically during class instantiation.
27		*/
28	54	public function __construct($dbConn)
29		{
30	54	$this->tableName = self::getClassName();
31	54	$this->dataBaseQuery = new DataBaseQuery($dbConn);
32	54	$this->arrayField['id'] = 0;
33	54	}
34
35		/**
36		* The magic setter method.
37		*
38		* @param $properties
39		* @param $values
40		*
41		* @return array associative array properties
42		*/
43		public function __set($properties, $values)
44		{
45		$this->arrayField[$properties] = $values;
46		}
47
48		/**
49		* The magic getter method.
50		*
51		* @param $properties
52		*
53		* @return array key
54		*/
55		public function __get($properties)
56		{
57		return $this->arrayField[$properties];
58		}
59
60		/**
61		* This method gets all the record from a particular table
62		* by accessing the read method from the DataBaseQuery class.
63		*
64		*
65		* @return associative array
66		*/
67	6	public static function getAll($dbConn)
68		{
69	6	$sqlData = DataBaseQuery::read($id = false, self::getClassName(), $dbConn);
70
71	3	if (count($sqlData) > 0) {
72	3	return $sqlData;
73		}
74
75		self::throwNoDataFoundException();
76		}
77
78	3	public static function throwNoDataFoundException()
79		{
80	3	$message = "oops, no data found in the database";
81	3	throw new NoDataFoundException($message);
82		}
83
84		/**
85		* This method either create or update record in a database table
86		* by calling either the read method or create method in the
87		* DataBaseQuery class.
88		*
89		* @throws NoRecordUpdateException
90		* @throws EmptyArrayException
91		* @throws NoRecordCreatedException
92		*
93		* @return bool true or false;
94		*/
95		public function save($dbConn)
96		{
97		if ($this->arrayField['id']) {
98		$sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName(), $dbConn);
99
100		if ($this->checkIfRecordIsEmpty($sqlData)) {
101		$boolCommit = $this->dataBaseQuery->update(['id' => $this->arrayField['id']], $this->arrayField, self::getClassName(), $dbConn);
102
103		if ($boolCommit) {
104		return true;
105		}
106
107		$this->throwNoRecordUpdatedException();
108		}
109
110		$this->throwEmptyArrayException();
111		} else {
112
113		$boolCommit = $this->dataBaseQuery->create($this->arrayField, self::getClassName(), $dbConn);
114
115		if ($boolCommit) {
		0 ignored issues – show Bug Best Practice introduced 2016-03-14 20:45 UTC by Report Bug Copy Issue Report The expression `$boolCommit` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
116		return true;
117		}
118
119		$this->throwNoRecordCreatedException();
120		}
121
122		}
123
124	3	public function throwNoRecordUpdatedException()
125		{
126	3	$message = "oops, your record did not update succesfully";
127	3	throw new NoRecordUpdatedException($message);
128		}
129
130	3	public function throwEmptyArrayException()
131		{
132	3	$message = "data passed didn't match any record";
133	3	throw new EmptyArrayException($message);
134		}
135
136	3	public function throwNoRecordCreatedException()
137		{
138	3	$message = "oops,your record did not create succesfully";
139	3	throw new NoRecordCreatedException($message);
140		}
141
142		/**
143		* This method find a record by id.
144		*
145		* @param $id
146		*
147		* @throws ArgumentNumberIncorrectException
148		* @throws ArgumentNotFoundException
149		*
150		* @return object
151		*/
152	6	public static function findById($id)
153		{
154	6	$numArgs = func_num_args();
155
156	6	if ($numArgs > 1) {
157	3	throw new ArgumentNumberIncorrectException('Please input just one Argument');
158		}
159
160	3	if ($id == '') {
161	3	throw new ArgumentNotFoundException('No Argument found, please input an argument');
162		}
163
164		$staticFindInstance = new static();
		0 ignored issues – show Bug introduced 2016-03-22 16:37 UTC by Report Bug Copy Issue Report The call to `DataBaseModel::__construct()` misses a required argument `$dbConn`. This check looks for function calls that miss required arguments. Loading history...
165
166		$staticFindInstance->id = $id;
		0 ignored issues – show Documentation introduced 2016-03-14 20:45 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Demo\DataBaseModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
167
168		return $staticFindInstance;
169		}
170
171		/**
172		* This method find a record by id and returns
173		* all the data present in the id.
174		*
175		*
176		* @return associative array
177		*/
178		public function getById()
179		{
180		if ($this->arrayField['id']) {
181		$sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName(), $dbConn);
		0 ignored issues – show Bug introduced 2016-03-22 15:31 UTC by Report Bug Copy Issue Report The variable `$dbConn` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
182
183		return $sqlData;
184		}
185		}
186
187		/**
188		* This method delete a row from the table by the row id.
189		*
190		* @param $id
191	3	*
192		* @throws ArgumentNumberIncorrectException;
193	3	* @throws ArgumentNotFoundException;
194	3	*
195		* @return bool true
196		*/
197		public static function destroy($id, $dbConn)
198		{
199		$numArgs = func_num_args();
200		if ($numArgs > 2) {
201		throw new ArgumentNumberIncorrectException('Please input just one Argument');
202		}
203
204		if ($numArgs == ' ') {
205		throw new ArgumentNotFoundException('No Argument found, please input an argument');
206		}
207	9
208		DataBaseQuery::delete($id, self::getClassName(), $dbConn);
209	9
210	9	return true;
211	3	}
212
213		public static function getClassName()
214	6	{
215	3	$tableName = explode('\\', get_called_class());
216
217		return Inflector::pluralize(strtolower(end($tableName)));
218	3	}
219
220	3	/**
221		* This method check if the argument passed to this function is an array.
222		*
223	54	* @param $arrayOfRecord
224		*
225	54	* @return bool true
226		*/
227	54	public function checkIfRecordIsEmpty($arrayOfRecord)
228		{
229		if (count($arrayOfRecord) > 0) {
230		return true;
231		}
232
233		return false;
234		}
235		}
236

andela-araimi / potato-orm

Push — master ( 97890f...06ab37 )

DataBaseModel::throwDataEmptyException() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like