History_Model::updateTitleHistory() - Code Metrics - Inspection of "WIP User History | SEE: #69" - DakuTree/manga-tracker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aeefc0...361280 )

by Angus

created 2016-09-23 15:35 UTC

History_Model::updateTitleHistory() A

↳ Parent: History_Model

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	9
nc	2
nop	4
dl	0
loc	14
ccs	0
cts	0
cp	0
crap	6
rs	9.4285
c	0
b	0
f	0

<?php declare(strict_types=1); defined('BASEPATH') OR exit('No direct script access allowed');

class History_Model extends CI_Model {
	public function __construct() {
		parent::__construct();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

		$this->load->database();
	}

	/*** TITLE HISTORY ***/
	public function updateTitleHistory(int $titleID, $oldChapter, string $newChapter, string $newChapterTimestamp) {
		$success = TRUE;
		if($oldChapter !== $newChapter) {
			$success = $this->db->insert('tracker_titles_history', [
				'title_id'    => $titleID,

				'old_chapter' => $oldChapter,
				'new_chapter' => $newChapter,

				'updated_at'  => $newChapterTimestamp
			]);
		}
		return (bool) $success;
	}

	/*** USER HISTORY ***/
	public function userAddTitle(int $chapterID, string $chapter, string $category) : bool {

		$success = $this->db->insert('tracker_titles_history', [
			'chapter_id'  => $chapterID,

			'type'        => '1',
			'custom1'     => $chapter,
			'custom2'     => $category,

			'updated_at'  => date('Y-m-d H:i:s')
		]);

		return $success;
	}
	public function userUpdateTitle(int $chapterID, string $old_chapter, string $new_chapter) : bool {

		$success = $this->db->insert('tracker_titles_history', [
			'chapter_id'  => $chapterID,

			'type'        => '2',
			'custom1'     => $old_chapter,
			'custom2'     => $new_chapter,

			'updated_at'  => date('Y-m-d H:i:s')
		]);

		return $success;
	}
	public function userRemoveTitle(int $chapterID) : bool {
		$success = $this->db->insert('tracker_titles_history', [
			'chapter_id'  => $chapterID,

			'type'        => '3',

			'updated_at'  => date('Y-m-d H:i:s')
		]);

		return $success;
	}
	public function userUpdateTags(int $chapterID, string/*|null*/ $old_tags, string $new_tags) : bool {

		$success = $this->db->insert('tracker_titles_history', [
			'chapter_id'  => $chapterID,

			'type'        => '4',
			'custom1'     => $old_tags,
			'custom2'     => $new_tags,

			'updated_at'  => date('Y-m-d H:i:s')
		]);

		return $success;
	}
	public function userUpdateCategory(int $chapterID, string $old_category, string $new_category) : bool {

		$success = $this->db->insert('tracker_titles_history', [
			'chapter_id'  => $chapterID,

			'type'        => '5',
			'custom1'     => $old_category,
			'custom2'     => $new_category,

			'updated_at'  => date('Y-m-d H:i:s')
		]);

		return $success;
	}
}


1			<?php declare(strict_types=1); defined('BASEPATH') OR exit('No direct script access allowed');
2
3			class History_Model extends CI_Model {
4	94		public function __construct() {
5	94		parent::__construct();
			1 ignored issue – show Bug introduced 2016-09-20 02:51 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `CI_Model` as the method `__construct()` does only exist in the following sub-classes of `CI_Model`: `Auth_Model`, `Batoto`, `DynastyScans`, `GameOfScanlation`, `History_Model`, `KireiCake`, `KissManga`, `MangaFox`, `MangaHere`, `MangaPanda`, `MangaStream`, `Site_Model`, `Sites_Model`, `Tracker_Model`, `User_Model`, `User_Options_Model`, `WebToons`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
6
7	94		$this->load->database();
8	94		}
9
10			/* TITLE HISTORY */
11			public function updateTitleHistory(int $titleID, $oldChapter, string $newChapter, string $newChapterTimestamp) {
12			$success = TRUE;
13			if($oldChapter !== $newChapter) {
14			$success = $this->db->insert('tracker_titles_history', [
15			'title_id' => $titleID,
16
17			'old_chapter' => $oldChapter,
18			'new_chapter' => $newChapter,
19
20			'updated_at' => $newChapterTimestamp
21			]);
22			}
23			return (bool) $success;
24			}
25
26			/* USER HISTORY */
27		View Code Duplication	public function userAddTitle(int $chapterID, string $chapter, string $category) : bool {
			1 ignored issue – show Duplication introduced 2016-09-23 15:38 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...
28			$success = $this->db->insert('tracker_titles_history', [
29			'chapter_id' => $chapterID,
30
31			'type' => '1',
32			'custom1' => $chapter,
33			'custom2' => $category,
34
35			'updated_at' => date('Y-m-d H:i:s')
36			]);
37
38			return $success;
39			}
40		View Code Duplication	public function userUpdateTitle(int $chapterID, string $old_chapter, string $new_chapter) : bool {
			1 ignored issue – show Duplication introduced 2016-09-23 15:38 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...
41			$success = $this->db->insert('tracker_titles_history', [
42			'chapter_id' => $chapterID,
43
44			'type' => '2',
45			'custom1' => $old_chapter,
46			'custom2' => $new_chapter,
47
48			'updated_at' => date('Y-m-d H:i:s')
49			]);
50
51			return $success;
52			}
53			public function userRemoveTitle(int $chapterID) : bool {
54			$success = $this->db->insert('tracker_titles_history', [
55			'chapter_id' => $chapterID,
56
57			'type' => '3',
58
59			'updated_at' => date('Y-m-d H:i:s')
60			]);
61
62			return $success;
63			}
64		View Code Duplication	public function userUpdateTags(int $chapterID, string/\|null/ $old_tags, string $new_tags) : bool {
			1 ignored issue – show Duplication introduced 2016-09-23 15:38 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...
65			$success = $this->db->insert('tracker_titles_history', [
66			'chapter_id' => $chapterID,
67
68			'type' => '4',
69			'custom1' => $old_tags,
70			'custom2' => $new_tags,
71
72			'updated_at' => date('Y-m-d H:i:s')
73			]);
74
75			return $success;
76			}
77		View Code Duplication	public function userUpdateCategory(int $chapterID, string $old_category, string $new_category) : bool {
			1 ignored issue – show Duplication introduced 2016-09-23 15:38 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...
78			$success = $this->db->insert('tracker_titles_history', [
79			'chapter_id' => $chapterID,
80
81			'type' => '5',
82			'custom1' => $old_category,
83			'custom2' => $new_category,
84
85			'updated_at' => date('Y-m-d H:i:s')
86			]);
87
88			return $success;
89			}
90			}
91

DakuTree / manga-tracker

Push — master ( aeefc0...361280 )

History_Model::updateTitleHistory() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like