DataBaseModel::throwNoRecordUpdatedException() - Code Metrics - Inspection of "testing" - andela-araimi/potato-orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c3a63...901465 )

by Adeola

created 2016-03-22 17:37 UTC

DataBaseModel::throwNoRecordUpdatedException() A

↳ Parent: DataBaseModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?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.
     *
     * @throws NoDataFoundException
     *
     * @return associative array
     */
    public static function getAll($dbConn)
    {
        $sqlData = DataBaseQuery::read($id = false, self::getClassName(), $dbConn);

        return $sqlData;
    }
            
    /**
     * 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();

                // throw new NoRecordUpdatedException('oops, your record did not update succesfully');

            }

            throw new EmptyArrayException("data passed didn't match any record");
        } else {

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

            if ($boolCommit) {

                return true;
            }

            throw new NoRecordCreatedException('oops,your record did not create succesfully');
        }
   
    }

    public function throwNoRecordUpdatedException()
    {
        $message = 'oops, your record did not update succesfully';
        throw new NoRecordUpdatedException($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	42	public function __construct($dbConn)
29		{
30	42	$this->tableName = self::getClassName();
31	3	$this->dataBaseQuery = new DataBaseQuery($dbConn);
32		$this->arrayField['id'] = 0;
33	42	}
34
35	42	/**
36	42	* The magic setter method.
37	42	*
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	42
48		/**
49	42	* The magic getter method.
50	42	*
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		* @throws NoDataFoundException
65		*
66		* @return associative array
67		*/
68		public static function getAll($dbConn)
69		{
70		$sqlData = DataBaseQuery::read($id = false, self::getClassName(), $dbConn);
71
72	6	return $sqlData;
73		}
74	6
75		/**
76	3	* This method either create or update record in a database table
77		* by calling either the read method or create method in the
78		* DataBaseQuery class.
79		*
80		* @throws NoRecordUpdateException
81		* @throws EmptyArrayException
82		* @throws NoRecordCreatedException
83		*
84		* @return bool true or false;
85		*/
86		public function save($dbConn)
87		{
88		if ($this->arrayField['id']) {
89		$sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName(), $dbConn);
90	2
91		if ($this->checkIfRecordIsEmpty($sqlData)) {
92		$boolCommit = $this->dataBaseQuery->update(['id' => $this->arrayField['id']], $this->arrayField, self::getClassName(), $dbConn);
93
94		if ($boolCommit) {
95		return true;
96		}
97
98		$this->throwNoRecordUpdatedException();
99	2
100		// throw new NoRecordUpdatedException('oops, your record did not update succesfully');
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-22 17:39 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
101		}
102
103		throw new EmptyArrayException("data passed didn't match any record");
104		} else {
105
106		$boolCommit = $this->dataBaseQuery->create($this->arrayField, self::getClassName(), $dbConn);
107
108		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...
109		return true;
110		}
111
112		throw new NoRecordCreatedException('oops,your record did not create succesfully');
113		}
114
115		}
116
117		public function throwNoRecordUpdatedException()
118		{
119		$message = 'oops, your record did not update succesfully';
120		throw new NoRecordUpdatedException($message);
121		}
122
123		/**
124		* This method find a record by id.
125		*
126		* @param $id
127		*
128		* @throws ArgumentNumberIncorrectException
129	9	* @throws ArgumentNotFoundException
130		*
131	9	* @return object
132		*/
133	9	public static function findById($id)
134	3	{
135		$numArgs = func_num_args();
136
137	6	if ($numArgs > 1) {
138	3	throw new ArgumentNumberIncorrectException('Please input just one Argument');
139		}
140
141	3	if ($id == '') {
142		throw new ArgumentNotFoundException('No Argument found, please input an argument');
143		}
144
145		$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...
146
147		$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...
148
149		return $staticFindInstance;
150		}
151
152		/**
153		* This method find a record by id and returns
154		* all the data present in the id.
155		*
156		*
157		* @return associative array
158		*/
159		public function getById()
160		{
161		if ($this->arrayField['id']) {
162		$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...
163
164		return $sqlData;
165		}
166		}
167
168		/**
169		* This method delete a row from the table by the row id.
170		*
171		* @param $id
172		*
173		* @throws ArgumentNumberIncorrectException;
174	9	* @throws ArgumentNotFoundException;
175		*
176	9	* @return bool true
177	9	*/
178	3	public static function destroy($id, $dbConn)
179		{
180		$numArgs = func_num_args();
181	6	if ($numArgs > 2) {
182	3	throw new ArgumentNumberIncorrectException('Please input just one Argument');
183		}
184
185	3	if ($numArgs == ' ') {
186		throw new ArgumentNotFoundException('No Argument found, please input an argument');
187	3	}
188
189		DataBaseQuery::delete($id, self::getClassName(), $dbConn);
190	42
191		return true;
192	42	}
193
194	42	public static function getClassName()
195		{
196		$tableName = explode('\\', get_called_class());
197
198		return Inflector::pluralize(strtolower(end($tableName)));
199		}
200
201		/**
202		* This method check if the argument passed to this function is an array.
203		*
204	6	* @param $arrayOfRecord
205		*
206	6	* @return bool true
207	3	*/
208		public function checkIfRecordIsEmpty($arrayOfRecord)
209		{
210	3	if (count($arrayOfRecord) > 0) {
211		return true;
212		}
213
214		return false;
215		}
216		}
217

andela-araimi / potato-orm

Push — master ( 6c3a63...901465 )

DataBaseModel::throwNoRecordUpdatedException() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like