ForeignKey - Code Metrics - czogori/Rentgen - Measure and Improve Code Quality continuously with Scrutinizer

ForeignKey A
last analyzed 2015-12-11 15:33 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	289
Duplicated Lines	11.76 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	9
Bugs	3	Features	3

Metric	Value
wmc	26
c	9
b	3
f	3
lcom	2
cbo	1
dl	34
loc	289
rs	10

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getName()	0	7	1
A	getTable()	0	4	1
A	setTable()	0	6	1
A	getReferencedTable()	0	4	1
A	setColumns()	9	9	2
A	getColumns()	0	4	1
A	setReferencedColumns()	9	9	2
A	getReferencedColumns()	0	4	1
A	getUpdateAction()	0	4	1
A	getDeleteAction()	0	4	1
A	setUpdateAction()	8	8	2
A	setDeleteAction()	8	8	2
A	updateRestrict()	0	6	1
A	updateCascade()	0	6	1
A	updateSetNull()	0	6	1
A	updateSetDefault()	0	6	1
A	deleteRestrict()	0	6	1
A	deleteCascade()	0	6	1
A	deleteSetNull()	0	6	1
A	deleteSetDefault()	0	6	1
A	getAvailableActions()	0	10	1

How to fix Duplicated Code

<?php

namespace Rentgen\Database\Constraint;

use Rentgen\Database\Table;

class ForeignKey implements ConstraintInterface
{

    const ACTION_NO_ACTION = 'NO ACTION';
    const ACTION_CASCADE   = 'CASCADE';
    const ACTION_RESTICT   = 'RESTRICT';
    const ACTION_DEFAULT   = 'SET DEFAULT';
    const ACTION_SET_NULL  = 'SET NULL';

    private $columns;
    private $table;
    private $referencedTable;
    private $updateAction;
    private $deleteAction;

    /**
     * Constructor.
     *
     * @param Table $table           Table instance.
     * @param Table $referencedTable Table reference instance.
     */
    public function __construct(Table $table, Table $referencedTable)
    {
        $this->table = $table;
        $this->referencedTable = $referencedTable;

        $this->updateAction = $this->deleteAction = self::ACTION_NO_ACTION;
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        $tableName = $this->table->getName();
        $columnsAsString = implode('_', $this->columns);

        return $tableName . '_' . $columnsAsString . '_fkey';
    }

    /**
     * {@inheritdoc}
     */
    public function getTable()
    {
        return $this->table;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Sets a table instance.
     *
     * @param Table $table Table instance.
     *
     * @return PrimaryKey Self.
     */
    public function setTable(Table $table)
    {
        $this->table = $table;

        return $this;
    }

    /**
     * Gets a reference table name.
     *
     * @return string Reference table name.
     */
    public function getReferencedTable()
    {
        return $this->referencedTable;
    }

    /**
     * Sets foreign key columns.
     *
     * @param array $columns Columns list.
     *
     * @return ForeignKey Self instance.
     */
    public function setColumns($columns)

    {
        if (!is_array($columns)) {
            $columns = array($columns);
        }
        $this->columns = $columns;

        return $this;
    }

    /**
     * Gets column names.
     *
     * @return array Column names.
     */
    public function getColumns()
    {
        return $this->columns;
    }

    /**
     * Sets foreign key reference columns.
     *
     * @param array $columns Columns list.
     *
     * @return ForeignKey Self instance.
     */
    public function setReferencedColumns($columns)

    {
        if (!is_array($columns)) {
            $columns = array($columns);
        }
        $this->referencedColumns = $columns;


        return $this;
    }

    /**
     * Gets reference column names.
     *
     * @return array Column names.
     */
    public function getReferencedColumns()
    {
        return $this->referencedColumns;

    }

    /**
     * Gets an update action.
     *
     * @return string
     */
    public function getUpdateAction()
    {
        return $this->updateAction;
    }

    /**
     * Gets a delete action.
     *
     * @return string
     */
    public function getDeleteAction()
    {
        return $this->deleteAction;
    }

    /**
     * Sets an update action.
     *
     * @param string $updateAction Update action.
     *
     * @throws InvalidArgumentException If the provided argument is not of action type.
     *
     * @return void
     */
    public function setUpdateAction($updateAction)

    {
        $updateAction = strtoupper($updateAction);
        if (!in_array($updateAction, $this->getAvailableActions())) {
            throw new \InvalidArgumentException(sprintf('Action %s does not exist.', $updateAction));
        }
        $this->updateAction = $updateAction;
    }

    /**
     * Sets a delete action.
     *
     * @param string $deleteAction Delete action.
     *
     * @throws InvalidArgumentException If the provided argument is not of action type.
     *
     * @return void
     */
    public function setDeleteAction($deleteAction)

    {
        $deleteAction = strtoupper($deleteAction);
        if (!in_array($deleteAction, $this->getAvailableActions())) {
           throw new \InvalidArgumentException(sprintf('Action %s does not exist.', $deleteAction));
        }
        $this->deleteAction = $deleteAction;
    }

    /**
     * Sets an update action on restrict.
     *
     * @return ForeignKey
     */
    public function updateRestrict()
    {
        $this->updateAction = self::ACTION_RESTICT;

        return $this;
    }

    /**
     * Sets an update action on cascade.
     *
     * @return ForeignKey
     */
    public function updateCascade()
    {
        $this->updateAction = self::ACTION_CASCADE;

        return $this;
    }

    /**
     * Sets an update action on set null.
     *
     * @return ForeignKey
     */
    public function updateSetNull()
    {
        $this->updateAction = self::ACTION_SET_NULL;

        return $this;
    }

    /**
     * Sets an update action on default.
     *
     * @return ForeignKey
     */
    public function updateSetDefault()
    {
        $this->updateAction = self::ACTION_DEFAULT;

        return $this;
    }

    /**
     * Sets a delete action on restrict.
     *
     * @return ForeignKey
     */
    public function deleteRestrict()
    {
        $this->deleteAction = self::ACTION_RESTICT;

        return $this;
    }

    /**
     * Sets a delete action on cascade.
     *
     * @return ForeignKey
     */
    public function deleteCascade()
    {
        $this->deleteAction = self::ACTION_CASCADE;

        return $this;
    }

    /**
     * Sets a delete action on set null.
     *
     * @return ForeignKey
     */
    public function deleteSetNull()
    {
        $this->deleteAction = self::ACTION_SET_NULL;

        return $this;
    }

    /**
     * Sets a delete action on default.
     *
     * @return ForeignKey
     */
    public function deleteSetDefault()
    {
        $this->deleteAction = self::ACTION_DEFAULT;

        return $this;
    }

    private function getAvailableActions()
    {
        return array(
            ForeignKey::ACTION_NO_ACTION,
            ForeignKey::ACTION_CASCADE,
            ForeignKey::ACTION_RESTICT,
            ForeignKey::ACTION_DEFAULT,
            ForeignKey::ACTION_SET_NULL
        );
    }
}


1		<?php
2
3		namespace Rentgen\Database\Constraint;
4
5		use Rentgen\Database\Table;
6
7		class ForeignKey implements ConstraintInterface
8		{
9
10		const ACTION_NO_ACTION = 'NO ACTION';
11		const ACTION_CASCADE = 'CASCADE';
12		const ACTION_RESTICT = 'RESTRICT';
13		const ACTION_DEFAULT = 'SET DEFAULT';
14		const ACTION_SET_NULL = 'SET NULL';
15
16		private $columns;
17		private $table;
18		private $referencedTable;
19		private $updateAction;
20		private $deleteAction;
21
22		/**
23		* Constructor.
24		*
25		* @param Table $table Table instance.
26		* @param Table $referencedTable Table reference instance.
27		*/
28		public function __construct(Table $table, Table $referencedTable)
29		{
30		$this->table = $table;
31		$this->referencedTable = $referencedTable;
32
33		$this->updateAction = $this->deleteAction = self::ACTION_NO_ACTION;
34		}
35
36		/**
37		* {@inheritdoc}
38		*/
39		public function getName()
40		{
41		$tableName = $this->table->getName();
42		$columnsAsString = implode('_', $this->columns);
43
44		return $tableName . '_' . $columnsAsString . '_fkey';
45		}
46
47		/**
48		* {@inheritdoc}
49		*/
50		public function getTable()
51		{
52		return $this->table;
		0 ignored issues – show Bug Best Practice introduced 2015-12-09 12:12 UTC by Report Bug Copy Issue Report The return type of `return $this->table;` (`Rentgen\Database\Table`) is incompatible with the return type declared by the interface `Rentgen\Database\Constra...aintInterface::getTable` of type `Rentgen\Database\Constraint\Table`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
53		}
54
55		/**
56		* Sets a table instance.
57		*
58		* @param Table $table Table instance.
59		*
60		* @return PrimaryKey Self.
61		*/
62		public function setTable(Table $table)
63		{
64		$this->table = $table;
65
66		return $this;
67		}
68
69		/**
70		* Gets a reference table name.
71		*
72		* @return string Reference table name.
73		*/
74		public function getReferencedTable()
75		{
76		return $this->referencedTable;
77		}
78
79		/**
80		* Sets foreign key columns.
81		*
82		* @param array $columns Columns list.
83		*
84		* @return ForeignKey Self instance.
85		*/
86	View Code Duplication	public function setColumns($columns)
		0 ignored issues – show Duplication introduced 2015-12-09 12:12 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		{
88		if (!is_array($columns)) {
89		$columns = array($columns);
90		}
91		$this->columns = $columns;
92
93		return $this;
94		}
95
96		/**
97		* Gets column names.
98		*
99		* @return array Column names.
100		*/
101		public function getColumns()
102		{
103		return $this->columns;
104		}
105
106		/**
107		* Sets foreign key reference columns.
108		*
109		* @param array $columns Columns list.
110		*
111		* @return ForeignKey Self instance.
112		*/
113	View Code Duplication	public function setReferencedColumns($columns)
		0 ignored issues – show Duplication introduced 2015-12-09 12:12 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...
114		{
115		if (!is_array($columns)) {
116		$columns = array($columns);
117		}
118		$this->referencedColumns = $columns;
		0 ignored issues – show Bug introduced 2015-12-09 12:12 UTC by Report Bug Copy Issue Report The property `referencedColumns` does not seem to exist. Did you mean `columns`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
119
120		return $this;
121		}
122
123		/**
124		* Gets reference column names.
125		*
126		* @return array Column names.
127		*/
128		public function getReferencedColumns()
129		{
130		return $this->referencedColumns;
		0 ignored issues – show Bug introduced 2015-12-09 12:12 UTC by Report Bug Copy Issue Report The property `referencedColumns` does not seem to exist. Did you mean `columns`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
131		}
132
133		/**
134		* Gets an update action.
135		*
136		* @return string
137		*/
138		public function getUpdateAction()
139		{
140		return $this->updateAction;
141		}
142
143		/**
144		* Gets a delete action.
145		*
146		* @return string
147		*/
148		public function getDeleteAction()
149		{
150		return $this->deleteAction;
151		}
152
153		/**
154		* Sets an update action.
155		*
156		* @param string $updateAction Update action.
157		*
158		* @throws InvalidArgumentException If the provided argument is not of action type.
159		*
160		* @return void
161		*/
162	View Code Duplication	public function setUpdateAction($updateAction)
		0 ignored issues – show Duplication introduced 2015-12-09 12:12 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...
163		{
164		$updateAction = strtoupper($updateAction);
165		if (!in_array($updateAction, $this->getAvailableActions())) {
166		throw new \InvalidArgumentException(sprintf('Action %s does not exist.', $updateAction));
167		}
168		$this->updateAction = $updateAction;
169		}
170
171		/**
172		* Sets a delete action.
173		*
174		* @param string $deleteAction Delete action.
175		*
176		* @throws InvalidArgumentException If the provided argument is not of action type.
177		*
178		* @return void
179		*/
180	View Code Duplication	public function setDeleteAction($deleteAction)
		0 ignored issues – show Duplication introduced 2015-12-09 12:12 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...
181		{
182		$deleteAction = strtoupper($deleteAction);
183		if (!in_array($deleteAction, $this->getAvailableActions())) {
184		throw new \InvalidArgumentException(sprintf('Action %s does not exist.', $deleteAction));
185		}
186		$this->deleteAction = $deleteAction;
187		}
188
189		/**
190		* Sets an update action on restrict.
191		*
192		* @return ForeignKey
193		*/
194		public function updateRestrict()
195		{
196		$this->updateAction = self::ACTION_RESTICT;
197
198		return $this;
199		}
200
201		/**
202		* Sets an update action on cascade.
203		*
204		* @return ForeignKey
205		*/
206		public function updateCascade()
207		{
208		$this->updateAction = self::ACTION_CASCADE;
209
210		return $this;
211		}
212
213		/**
214		* Sets an update action on set null.
215		*
216		* @return ForeignKey
217		*/
218		public function updateSetNull()
219		{
220		$this->updateAction = self::ACTION_SET_NULL;
221
222		return $this;
223		}
224
225		/**
226		* Sets an update action on default.
227		*
228		* @return ForeignKey
229		*/
230		public function updateSetDefault()
231		{
232		$this->updateAction = self::ACTION_DEFAULT;
233
234		return $this;
235		}
236
237		/**
238		* Sets a delete action on restrict.
239		*
240		* @return ForeignKey
241		*/
242		public function deleteRestrict()
243		{
244		$this->deleteAction = self::ACTION_RESTICT;
245
246		return $this;
247		}
248
249		/**
250		* Sets a delete action on cascade.
251		*
252		* @return ForeignKey
253		*/
254		public function deleteCascade()
255		{
256		$this->deleteAction = self::ACTION_CASCADE;
257
258		return $this;
259		}
260
261		/**
262		* Sets a delete action on set null.
263		*
264		* @return ForeignKey
265		*/
266		public function deleteSetNull()
267		{
268		$this->deleteAction = self::ACTION_SET_NULL;
269
270		return $this;
271		}
272
273		/**
274		* Sets a delete action on default.
275		*
276		* @return ForeignKey
277		*/
278		public function deleteSetDefault()
279		{
280		$this->deleteAction = self::ACTION_DEFAULT;
281
282		return $this;
283		}
284
285		private function getAvailableActions()
286		{
287		return array(
288		ForeignKey::ACTION_NO_ACTION,
289		ForeignKey::ACTION_CASCADE,
290		ForeignKey::ACTION_RESTICT,
291		ForeignKey::ACTION_DEFAULT,
292		ForeignKey::ACTION_SET_NULL
293		);
294		}
295		}
296

czogori / Rentgen

GitHub Access Token became invalid

ForeignKey A last analyzed 2015-12-11 15:33 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

22 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

ForeignKey A
last analyzed 2015-12-11 15:33 UTC