DBTimedObject - Code Metrics - Asymptix/Framework - Measure and Improve Code Quality continuously with Scrutinizer

DBTimedObject A
last analyzed 2018-07-31 14:35 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	86
Duplicated Lines	32.56 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	28
loc	86
rs	10
c	0
b	0
f	0
wmc	6
lcom	1
cbo	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	changeCreateTime()	0	6	1
A	changeUpdateTime()	0	6	1
A	save()	0	9	2
A	saveActivationFlag()	14	14	1
A	saveRemovementFlag()	14	14	1

How to fix Duplicated Code

<?php

namespace Asymptix\db;

/**
 * Wraper for DBObject with fields for storing creation and updating time and
 * user ID.
 *
 * @category Asymptix PHP Framework
 * @author Dmytro Zarezenko <[email protected]>
 * @copyright (c) 2013 - 2016, Dmytro Zarezenko
 *
 * @git https://github.com/Asymptix/Framework
 * @license http://opensource.org/licenses/MIT
 */
class DBTimedObject extends DBObject {

    /**
     * Changes record creation time and user Id.
     *
     * @global DBObject $_USER User object.
     */
    private function changeCreateTime() {
        global $_USER;
function myFunction($a, $b) {
    // Do something
}

        $this->createTime = date("Y-m-d H:i:s");
<?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.");
        }
    }

}
        $this->createUserId = $_USER->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.");
        }
    }

}
    }

    /**
     * Changes record updating time and user Id.
     *
     * @global DBObject $_USER User object.
     */
    private function changeUpdateTime() {
        global $_USER;
function myFunction($a, $b) {
    // Do something
}

        $this->updateTime = date("Y-m-d H:i:s");
<?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.");
        }
    }

}
        $this->updateUserId = $_USER->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.");
        }
    }

}
    }

    /**
     * Save record to the database.
     *
     * @param bool $debug Debug mode flag.
     *
     * @return int Id of the record.
     */
    public function save($debug = false) {
        if ($this->isNewRecord()) { // new record
            $this->changeCreateTime();
        } else {
            $this->changeUpdateTime();
        }

        return parent::save($debug);
    }

    /**
     * Saves activation flag to the database.
     *
     * @return int Returns the number of affected rows on success, and -1 if
     *            the last query failed.
     */
    public function saveActivationFlag() {

        $this->changeUpdateTime();

        return DBCore::doUpdateQuery(
            "UPDATE " . static::TABLE_NAME . "
                SET activation = ?,
                    update_time = ?,
                    update_user_id = ?
             WHERE " . static::ID_FIELD_NAME . " = ?
             LIMIT 1",
            "isii",
            [$this->activation, $this->updateTime, $this->updateUserId, $this->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.");
        }
    }

}
        );
    }

    /**
     * Saves removement flag to the database.
     *
     * @return int Returns the number of affected rows on success, and -1 if
     *            the last query failed.
     */
    public function saveRemovementFlag() {

        $this->changeUpdateTime();

        return DBCore::doUpdateQuery(
            "UPDATE " . static::TABLE_NAME . "
                SET removed = ?,
                    update_time = ?,
                    update_user_id = ?
             WHERE " . static::ID_FIELD_NAME . " = ?
             LIMIT 1",
            "isii",
            [$this->removed, $this->updateTime, $this->updateUserId, $this->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.");
        }
    }

}
        );
    }

}


1		<?php
2
3		namespace Asymptix\db;
4
5		/**
6		* Wraper for DBObject with fields for storing creation and updating time and
7		* user ID.
8		*
9		* @category Asymptix PHP Framework
10		* @author Dmytro Zarezenko <[email protected]>
11		* @copyright (c) 2013 - 2016, Dmytro Zarezenko
12		*
13		* @git https://github.com/Asymptix/Framework
14		* @license http://opensource.org/licenses/MIT
15		*/
16		class DBTimedObject extends DBObject {
17
18		/**
19		* Changes record creation time and user Id.
20		*
21		* @global DBObject $_USER User object.
22		*/
23		private function changeCreateTime() {
24		global $_USER;
		0 ignored issues – show Compatibility Best Practice introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
25
26		$this->createTime = date("Y-m-d H:i:s");
		0 ignored issues – show Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `createTime` does not exist on `object<Asymptix\db\DBTimedObject>`. 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...
27		$this->createUserId = $_USER->id;
		0 ignored issues – show Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `createUserId` does not exist on `object<Asymptix\db\DBTimedObject>`. 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...
28		}
29
30		/**
31		* Changes record updating time and user Id.
32		*
33		* @global DBObject $_USER User object.
34		*/
35		private function changeUpdateTime() {
36		global $_USER;
		0 ignored issues – show Compatibility Best Practice introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
37
38		$this->updateTime = date("Y-m-d H:i:s");
		0 ignored issues – show Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `updateTime` does not exist on `object<Asymptix\db\DBTimedObject>`. 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...
39		$this->updateUserId = $_USER->id;
		0 ignored issues – show Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `updateUserId` does not exist on `object<Asymptix\db\DBTimedObject>`. 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...
40		}
41
42		/**
43		* Save record to the database.
44		*
45		* @param bool $debug Debug mode flag.
46		*
47		* @return int Id of the record.
48		*/
49		public function save($debug = false) {
50		if ($this->isNewRecord()) { // new record
51		$this->changeCreateTime();
52		} else {
53		$this->changeUpdateTime();
54		}
55
56		return parent::save($debug);
57		}
58
59		/**
60		* Saves activation flag to the database.
61		*
62		* @return int Returns the number of affected rows on success, and -1 if
63		* the last query failed.
64		*/
65	View Code Duplication	public function saveActivationFlag() {
		0 ignored issues – show Duplication introduced 2017-09-25 18:26 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
66		$this->changeUpdateTime();
67
68		return DBCore::doUpdateQuery(
69		"UPDATE " . static::TABLE_NAME . "
70		SET activation = ?,
71		update_time = ?,
72		update_user_id = ?
73		WHERE " . static::ID_FIELD_NAME . " = ?
74		LIMIT 1",
75		"isii",
76		[$this->activation, $this->updateTime, $this->updateUserId, $this->id]
		0 ignored issues – show Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `activation` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `updateTime` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `updateUserId` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
77		);
78		}
79
80		/**
81		* Saves removement flag to the database.
82		*
83		* @return int Returns the number of affected rows on success, and -1 if
84		* the last query failed.
85		*/
86	View Code Duplication	public function saveRemovementFlag() {
		0 ignored issues – show Duplication introduced 2017-09-25 18:26 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87		$this->changeUpdateTime();
88
89		return DBCore::doUpdateQuery(
90		"UPDATE " . static::TABLE_NAME . "
91		SET removed = ?,
92		update_time = ?,
93		update_user_id = ?
94		WHERE " . static::ID_FIELD_NAME . " = ?
95		LIMIT 1",
96		"isii",
97		[$this->removed, $this->updateTime, $this->updateUserId, $this->id]
		0 ignored issues – show Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `removed` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `updateTime` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `updateUserId` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Asymptix\db\DBTimedObject>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
98		);
99		}
100
101		}
102

Asymptix / Framework

DBTimedObject A last analyzed 2018-07-31 14:35 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like

DBTimedObject A
last analyzed 2018-07-31 14:35 UTC