DBAL\DbSqlPaging

Complexity

Total Complexity

19

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	valid()	0	2	2
A	count()	0	2	2
A	seekToFirst()	0	3	2
A	__construct()	0	8	2
A	getPageZeroRecordNum()	0	2	1
A	getTotalPages()	0	2	2
A	getCurrentPageNumber()	0	2	1
A	query()	0	20	4
A	getRecordsOnCurrentPage()	0	2	1
A	getTotalRecords()	0	2	2

<?php
/**
 * Created by Gorlum 25.11.2017 18:49
 */

namespace DBAL;

use mysqli_result;

/**
 * Class DbSqlPaging
 *
 * Another implementation for DbAbstractResultIterator
 *
 * Fetches data from string SQL-query and pages through it
 *
 * @package DBAL
 */
class DbSqlPaging extends DbAbstractResultIterator {
  protected $db = null;
  protected $sqlQuery;
  protected $pageSize = PAGING_PAGE_SIZE_DEFAULT;
  protected $currentPage = 1;

  /**
   * DbSqlPaging constructor.
   *
   * @param string         $sqlQuery
   * @param int            $pageSize
   * @param int            $currentPage
   * @param \db_mysql|null $db
   */
  public function __construct($sqlQuery, $pageSize = PAGING_PAGE_SIZE_DEFAULT, $currentPage = 1, $db = null) {
    $this->sqlQuery = $sqlQuery;
    $this->pageSize = max(intval($pageSize), PAGING_PAGE_SIZE_MINIMUM);
    $this->currentPage = max(intval($currentPage), 1);

    $this->db = isset($db) ? $db : \classSupernova::$gc->db;

    $this->query();
  }

  /**
   * @inheritdoc
   */
  public function valid() {
    return parent::valid() && $this->counter < $this->getRecordsOnCurrentPage();
  }

  /**
   * @inheritdoc
   */
  public function count() {
    return $this->mysqli_result instanceof mysqli_result ? $this->getRecordsOnCurrentPage() : 0;
  }

  /**
   * @inheritdoc
   */
  protected function seekToFirst() {
    if ($this->mysqli_result instanceof mysqli_result) {
      $this->mysqli_result->data_seek($this->getPageZeroRecordNum());
    }
  }

  /**
   * Get current page number
   *
   * @return int
   */
  public function getCurrentPageNumber() {
    return $this->currentPage;
  }

  /**
   * Get total number of records in query
   *
   * @return int
   */
  public function getTotalRecords() {
    return $this->mysqli_result instanceof mysqli_result ? $this->mysqli_result->num_rows : 0;
  }

  /**
   * Calculates total page numbers
   *
   * @return float|int
   */
  public function getTotalPages() {
    return $this->mysqli_result instanceof mysqli_result ? ceil($this->getTotalRecords() / $this->pageSize) : 0;
  }

  /**
   * Calculates record count on current page
   *
   * @return int
   */
  public function getRecordsOnCurrentPage() {
    return min($this->pageSize, $this->getTotalRecords() - $this->getPageZeroRecordNum());
  }

  /**
   * Calculates record index from which current page starts
   *
   * @return int
   */
  protected function getPageZeroRecordNum() {
    return ($this->currentPage - 1) * $this->pageSize;
  }

  /**
   * Queries DB for data and makes all necessary preparations
   */
  protected function query() {
    if ($this->mysqli_result !== null) {
      unset($this->mysqli_result);
    }
    // Performing query
    $this->mysqli_result = $this->db->doquery($this->sqlQuery);

It seems like $this->db->doquery($this->sqlQuery) can also be of type array. However, the property $mysqli_result is declared as type false|mysqli_result. Maybe add an additional type check?

    // Checking if page number within allowed ranges
    if (
      // Is it not a first page?
      $this->currentPage != 1
      &&
      // Is current page beyond limits?
      $this->currentPage > $this->getTotalPages()
    ) {
      // Correcting page number to first
      $this->currentPage = max(1, $this->getTotalPages());
    }

    $this->rewind();
  }

}