DBStaticRecord::buildSelectLock() - Code Metrics - Inspection of "CODE-misc-41a7.59: Moved msg_sen_simple_message()..." - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — work-fleets ( e04805...964a94 )

by SuperNova.WS

created 2016-05-28 13:34 UTC

DBStaticRecord::buildSelectLock() A

↳ Parent: DBStaticRecord

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	5
rs	9.4285
c	2
b	0
f	0
ccs	0
cts	3
cp	0
crap	2

<?php

/**
 * Class DBStaticRecord
 */
class DBStaticRecord {

  public static $_table = '_table';
  public static $_idField = 'id';

  /**
   * @var db_mysql $dbStatic
   */
  protected static $dbStatic;

  /**
   * DBStaticRecord constructor.
   *
   * @param db_mysql|null $db
   */
  public static function _init($db = null) {
    static::$dbStatic = (!empty($db) && $db instanceof db_mysql) || !class_exists('classSupernova', false) ? $db : classSupernova::$db;
  }

  /**
   * @return DbSqlStatement
   */
  public static function buildSelect() {
    return
      DbSqlStatement::build(null)
        ->getParamsFromStaticClass(get_called_class())
        ->select();
  }

  /**
   * @return DbSqlStatement
   */
  public static function buildSelectCountId() {
    return
      static::buildSelect()
        ->fieldCount(static::$_idField);
  }

  /**
   * @return DbSqlStatement
   */
  public static function buildSelectAll() {
    return
      static::buildSelect()
        ->field('*');
  }

  /**
   * @return DbSqlStatement
   */
  public static function buildSelectLock() {
    return
      static::buildSelect()->field(1)
        ->forUpdate();
  }

  /**
   * @param array       $where
   * @param mixed|array $fieldList
   *     Field list can be scalar - it would be converted to array and used as field name
   * @param bool        $for_update
   *
   * @return array|null
   *
   * @see static::getRecordList
   */
  protected static function getRecord($where = array(), $fieldList = '*', $for_update = false) {

    $result = static::fetchOne(
      static::buildSelect()->fields($fieldList)
        ->where($where)
    );

    return $result;
  }

  /**
   * Get maximum ID from table
   *
   * @return int
   */
  public static function getMaxId() {
    $maxId = static::getRecord(array(), DbSqlLiteral::build()->max(static::$_idField, 'maxId'));

    return !empty($maxId['maxId']) ? $maxId['maxId'] : 0;
  }

  /**
   * @param int|string  $recordId
   * @param mixed|array $fieldList
   * @param bool        $forUpdate
   *
   * @return array|null
   */
  public static function getRecordById($recordId, $fieldList = '*', $forUpdate = false) {
    return static::getRecord(array(static::$_idField . '=' . $recordId), $fieldList, $forUpdate);
  }

  /**
   * @param DbSqlStatement $statement
   *
   * @return array|bool|mysqli_result|null
   */
  protected static function execute($statement) {
    return static::$dbStatic->execute((string)$statement);
  }

  /**
   * @param DbSqlStatement $statement
   *
   * @return array|null
   */
  protected static function fetchOne($statement) {
    return static::$dbStatic->fetchOne($statement);
  }

  /**
   * @param array $idList
   *
   * @return mysqli_result|null
   */
  /**
   * @param array $idList
   *
   * @return mysqli_result|null
   */
  public static function queryExistsIdInList($idList) {
    $query = null;
    if (!empty($idList) && is_array($idList)) {
      $query = static::execute(
        static::buildSelectAll()
          ->fields(static::$_idField)
          ->where(array("`" . static::$_idField . "` IN (" . implode(',', $idList) . ")"))
      );
    }

    return !empty($query) ? $query : null;
  }


  /**
   * @param string $idList
   *
   * @return string
   */
  public static function filterIdListStringRepack($idList) {
    // TODO - remove HelperArray caller
    $idList = HelperArray::stringToArrayFilterEmpty($idList);

    $result = array();
    if (!empty($idList)) {
      $query = static::queryExistsIdInList($idList);
      while($row = db_fetch($query)) {
        $result[] = $row[static::$_idField];
      }
    }

    // TODO - remove implode
    return implode(',', $result);
  }

  /**
   *
   */
  public static function lockAllRecords() {
    static::execute(
      static::buildSelectLock()
    );
  }

  /**
   * Builds and Executes prepared statement
   *
   * @param string $sqlQuery
   * @param array  $values
   *
   * @return array|bool|mysqli_result|null
   */
  protected static function prepareExecute($sqlQuery, $values = array()) {
    return static::$dbStatic->sqlPrepareAndExecute($sqlQuery, $values);
  }

  /**
   * Builds and executes prepared statement then return first record from sets
   *
   * @param string $sqlQuery
   * @param array  $values
   *
   * @return array|null
   */
  protected static function prepareFetchOne($sqlQuery, $values = array()) {
    return static::$dbStatic->db_fetch(static::prepareExecute($sqlQuery, $values));

  }

  /**
   * Builds and executes prepared statement then fetches first record from sets and returns value from first field
   *
   * @param string $sqlQuery
   * @param array  $values
   *
   * @return mixed|null
   */
  protected static function prepareFetchValue($sqlQuery, $values = array()) {
    $result = static::prepareFetchOne($sqlQuery, $values);
    if (empty($result) || !array($result)) {
      $result = null;
    } else {
      $result = array_pop($result);
    }

    return $result;
  }

}

DBStaticRecord::_init();


1			<?php
2
3			/**
4			* Class DBStaticRecord
5			*/
6			class DBStaticRecord {
7
8			public static $_table = '_table';
9			public static $_idField = 'id';
10
11			/**
12			* @var db_mysql $dbStatic
13			*/
14			protected static $dbStatic;
15
16			/**
17			* DBStaticRecord constructor.
18			*
19			* @param db_mysql\|null $db
20			*/
21			public static function _init($db = null) {
22			static::$dbStatic = (!empty($db) && $db instanceof db_mysql) \|\| !class_exists('classSupernova', false) ? $db : classSupernova::$db;
23			}
24
25			/**
26			* @return DbSqlStatement
27			*/
28			public static function buildSelect() {
29			return
30			DbSqlStatement::build(null)
31			->getParamsFromStaticClass(get_called_class())
32			->select();
33			}
34
35			/**
36			* @return DbSqlStatement
37			*/
38			public static function buildSelectCountId() {
39			return
40			static::buildSelect()
41			->fieldCount(static::$_idField);
42			}
43
44			/**
45			* @return DbSqlStatement
46			*/
47			public static function buildSelectAll() {
48			return
49			static::buildSelect()
50			->field('*');
51			}
52
53			/**
54			* @return DbSqlStatement
55			*/
56			public static function buildSelectLock() {
57			return
58			static::buildSelect()->field(1)
59			->forUpdate();
60			}
61
62			/**
63			* @param array $where
64			* @param mixed\|array $fieldList
65			* Field list can be scalar - it would be converted to array and used as field name
66			* @param bool $for_update
67			*
68			* @return array\|null
69			*
70			* @see static::getRecordList
71			*/
72			protected static function getRecord($where = array(), $fieldList = '*', $for_update = false) {
			0 ignored issues – show Unused Code introduced 2016-05-17 01:23 UTC by Report Bug Copy Issue Report The parameter `$for_update` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
73			$result = static::fetchOne(
74			static::buildSelect()->fields($fieldList)
75			->where($where)
76			);
77
78			return $result;
79			}
80
81			/**
82			* Get maximum ID from table
83			*
84			* @return int
85			*/
86			public static function getMaxId() {
87			$maxId = static::getRecord(array(), DbSqlLiteral::build()->max(static::$_idField, 'maxId'));
88
89			return !empty($maxId['maxId']) ? $maxId['maxId'] : 0;
90			}
91
92			/**
93			* @param int\|string $recordId
94			* @param mixed\|array $fieldList
95			* @param bool $forUpdate
96			*
97			* @return array\|null
98			*/
99			public static function getRecordById($recordId, $fieldList = '*', $forUpdate = false) {
100			return static::getRecord(array(static::$_idField . '=' . $recordId), $fieldList, $forUpdate);
101			}
102
103			/**
104			* @param DbSqlStatement $statement
105			*
106			* @return array\|bool\|mysqli_result\|null
107			*/
108			protected static function execute($statement) {
109			return static::$dbStatic->execute((string)$statement);
110			}
111
112			/**
113			* @param DbSqlStatement $statement
114			*
115			* @return array\|null
116			*/
117			protected static function fetchOne($statement) {
118			return static::$dbStatic->fetchOne($statement);
119			}
120
121			/**
122			* @param array $idList
123			*
124			* @return mysqli_result\|null
125			*/
126			/**
127			* @param array $idList
128			*
129			* @return mysqli_result\|null
130			*/
131			public static function queryExistsIdInList($idList) {
132			$query = null;
133			if (!empty($idList) && is_array($idList)) {
134			$query = static::execute(
135			static::buildSelectAll()
136			->fields(static::$_idField)
137			->where(array("`" . static::$_idField . "` IN (" . implode(',', $idList) . ")"))
138			);
139			}
140
141			return !empty($query) ? $query : null;
142			}
143
144
145			/**
146			* @param string $idList
147			*
148			* @return string
149			*/
150			public static function filterIdListStringRepack($idList) {
151			// TODO - remove HelperArray caller
152			$idList = HelperArray::stringToArrayFilterEmpty($idList);
153
154			$result = array();
155			if (!empty($idList)) {
156			$query = static::queryExistsIdInList($idList);
157			while($row = db_fetch($query)) {
158			$result[] = $row[static::$_idField];
159			}
160			}
161
162			// TODO - remove implode
163			return implode(',', $result);
164			}
165
166			/**
167			*
168			*/
169			public static function lockAllRecords() {
170			static::execute(
171			static::buildSelectLock()
172			);
173			}
174
175			/**
176			* Builds and Executes prepared statement
177			*
178			* @param string $sqlQuery
179			* @param array $values
180			*
181			* @return array\|bool\|mysqli_result\|null
182			*/
183			protected static function prepareExecute($sqlQuery, $values = array()) {
184			return static::$dbStatic->sqlPrepareAndExecute($sqlQuery, $values);
185			}
186
187			/**
188			* Builds and executes prepared statement then return first record from sets
189			*
190			* @param string $sqlQuery
191			* @param array $values
192			*
193			* @return array\|null
194			*/
195			protected static function prepareFetchOne($sqlQuery, $values = array()) {
196			return static::$dbStatic->db_fetch(static::prepareExecute($sqlQuery, $values));
			0 ignored issues – show Bug introduced 2016-05-23 15:45 UTC by Report Bug Copy Issue Report `static::prepareExecute($sqlQuery, $values)` cannot be passed to `db_fetch()` as the parameter `$query` expects a reference. Loading history...
197			}
198
199			/**
200			* Builds and executes prepared statement then fetches first record from sets and returns value from first field
201			*
202			* @param string $sqlQuery
203			* @param array $values
204			*
205			* @return mixed\|null
206			*/
207			protected static function prepareFetchValue($sqlQuery, $values = array()) {
208			$result = static::prepareFetchOne($sqlQuery, $values);
209			if (empty($result) \|\| !array($result)) {
210			$result = null;
211			} else {
212			$result = array_pop($result);
213			}
214
215			return $result;
216			}
217
218			}
219
220			DBStaticRecord::_init();
221

supernova-ws / SuperNova

Push — work-fleets ( e04805...964a94 )

DBStaticRecord::buildSelectLock() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like