Tracker_Favourites_Model

Complexity

Total Complexity

23

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

2.78%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
B	get()	0	44	6
A	getAll()	0	37	3
C	set()	0	91	13

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

class Tracker_Favourites_Model extends Tracker_Base_Model {
	public function __construct() {
		parent::__construct();
	}

	public function get(int $page) : array {
		$rowsPerPage = 50;
		$query = $this->db
			->select('SQL_CALC_FOUND_ROWS
			          tt.title, tt.title_url,
			          ts.site, ts.site_class,
			          tf.chapter, tf.page, tf.updated_at', FALSE)
			->from('tracker_favourites AS tf')
			->join('tracker_chapters AS tc', 'tf.chapter_id = tc.id', 'left')
			->join('tracker_titles AS tt',   'tc.title_id = tt.id',   'left')
			->join('tracker_sites AS ts',    'tt.site_id = ts.id',    'left')
			->where('tc.user_id', $this->User->id) //CHECK: Is this inefficient? Would it be better to have a user_id column in tracker_favourites?
			->order_by('tf.id DESC')
			->limit($rowsPerPage, ($rowsPerPage * ($page - 1)))
			->get();

		$favourites = ['rows' => [], 'totalPages' => 1];
		if($query->num_rows() > 0) {
			foreach($query->result() as $row) {
				$arrRow = [];

				$arrRow['updated_at'] = $row->updated_at;
				$arrRow['title']      = $row->title;
				$arrRow['title_url']  = $this->Tracker->sites->{$row->site_class}->getFullTitleURL($row->title_url);

				$arrRow['site']        = $row->site;
				$arrRow['site_sprite'] = str_replace('.', '-', $row->site);

				$chapterData = $this->Tracker->sites->{$row->site_class}->getChapterData($row->title_url, $row->chapter);
				$arrRow['chapter_url'] = "<a href=\"{$chapterData['url']}\">{$chapterData['number']}</a>";

				if(!is_null($row->page)) {
					$page_url = $this->Tracker->sites->{$row->site_class}->getChapterPageURL($chapterData, (!is_null($row->page) ? (int) $row->page : NULL));
					$chapterNumber = "{$chapterData['number']} | Page: {$row->page}";
					$arrRow['chapter_url'] = !is_null($page_url) ? "<a href=\"{$page_url}\">{$chapterNumber}</a>" : "<a href=\"{$chapterData['url']}\">{$chapterNumber} (No Direct URL)</a>";
				}

				$favourites['rows'][] = $arrRow;
			}
			$favourites['totalPages'] = ceil($this->db->query('SELECT FOUND_ROWS() count;')->row()->count / $rowsPerPage);
		}

		return $favourites;
	}
	public function getAll() : array {
		$query = $this->db
			->select('SQL_CALC_FOUND_ROWS
			          tt.title, tt.title_url,
			          ts.site, ts.site_class,
			          tf.chapter, tf.page, tf.updated_at', FALSE)
			->from('tracker_favourites AS tf')
			->join('tracker_chapters AS tc', 'tf.chapter_id = tc.id', 'left')
			->join('tracker_titles AS tt',   'tc.title_id = tt.id',   'left')
			->join('tracker_sites AS ts',    'tt.site_id = ts.id',    'left')
			->where('tc.user_id', $this->User->id) //CHECK: Is this inefficient? Would it be better to have a user_id column in tracker_favourites?
			->order_by('tf.id DESC')
			->get();

		$favourites = [];
		if($query->num_rows() > 0) {
			foreach($query->result() as $row) {
				$arrRow = [];

				$arrRow['updated_at'] = $row->updated_at;
				$arrRow['title']      = $row->title;
				$arrRow['title_url']  = $this->Tracker->sites->{$row->site_class}->getFullTitleURL($row->title_url);

				$arrRow['site']        = $row->site;
				$arrRow['chapter']     = $row->chapter;
				$arrRow['page']        = $row->page;

				$chapterData = $this->Tracker->sites->{$row->site_class}->getChapterData($row->title_url, $row->chapter);
				$arrRow['chapter_number'] = $chapterData['number'];
				$arrRow['chapter_url'] = $chapterData['url'];

				$favourites[] = $arrRow;
			}
		}

		return $favourites;
	}

	public function set(int $userID, string $site, string $title, string $chapter, ?int $page = NULL, bool $removeIfExists = TRUE) : array {
		$success = array(
			'status' => 'Something went wrong',
			'bool'   => FALSE
		);
		if($siteData = $this->Tracker->title->getSiteDataFromURL($site)) {
			//Validate user input
			if(!$this->sites->{$siteData->site_class}->isValidTitleURL($title)) {
				//Error is already logged via isValidTitleURL
				$success['status'] = 'Title URL is not valid';
				return $success;
			}
			if(!$this->sites->{$siteData->site_class}->isValidChapter($chapter)) {
				//Error is already logged via isValidChapter
				$success['status'] = 'Chapter URL is not valid';
				return $success;
			}

			//NOTE: If the title doesn't exist it will be created. This maybe isn't perfect, but it works for now.
			$titleID = $this->Tracker->title->getID($title, (int) $siteData->id);
			if($titleID === 0) {
				//Something went wrong.
				log_message('error', "TitleID = 0 for {$title} @ {$siteData->id}");

The call to the function log_message() seems unnecessary as the function has no side-effects.

				return $success;
			}

			////We need the series to be tracked
			$idCQuery = $this->db->select('id')
			                     ->where('user_id', $userID)
			                     ->where('title_id', $titleID)
			                     ->get('tracker_chapters');
			if(!($idCQuery->num_rows() > 0)) {
				//NOTE: This pretty much repeats a lot of what we already did above. Is there a better way to do this?
				$this->Tracker->list->update($userID, $site, $title, $chapter, FALSE);

				$idCQuery = $this->db->select('id')
				                     ->where('user_id', $userID)
				                     ->where('title_id', $titleID)
				                     ->get('tracker_chapters');
			}
			if($idCQuery->num_rows() > 0) {
				$idCQueryRow = $idCQuery->row();

				//Check if it is already favourited
				$idFQuery = $this->db->select('id')
				                     ->where('chapter_id', $idCQueryRow->id)
				                     ->where('chapter', $chapter)
				                     ->where('page', $page)
				                     ->get('tracker_favourites');
				if($idFQuery->num_rows() > 0) {
					//Chapter is already favourited, so remove it from DB
					if($removeIfExists) {
						$idFQueryRow = $idFQuery->row();

						$isSuccess = (bool) $this->db->where('id', $idFQueryRow->id)
						                             ->delete('tracker_favourites');

						if($isSuccess) {
							$success = array(
								'status' => 'Unfavourited' . ($page ? " page {$page}" : ''),
								'bool'   => TRUE
							);
							$this->History->userRemoveFavourite((int) $idCQueryRow->id, $chapter);
						}
					} else {
						$success = array(
							'status' => 'Favourite already exists',
							'bool'   => TRUE
						);
					}
				} else {
					//Chapter is not favourited, so add to DB.
					$isSuccess = (bool) $this->db->insert('tracker_favourites', [
						'chapter_id'      => $idCQueryRow->id,
						'chapter'         => $chapter,
						'page'            => $page,
						'updated_at'      => date('Y-m-d H:i:s')
					]);

					if($isSuccess) {
						$success = array(
							'status' => 'Favourited' . ($page ? " page {$page}" : ''),
							'bool'   => TRUE
						);
						$this->History->userAddFavourite((int) $idCQueryRow->id, $chapter);
					}
				}
			}
		}
		return $success;
	}
}