V2UnitModel::isEmpty() - Code Metrics - Inspection of "DBAL-misc-41a52.12: Moved $db from Model to rowOpe..." - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — work-fleets ( 9e987d...ec9dc8 )

by SuperNova.WS

created 2016-08-13 11:34 UTC

V2UnitModel::isEmpty() B

↳ Parent: V2UnitModel

Complexity

Conditions	7
Paths	7

Size

Total Lines	16
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	15
c	1
b	0
f	0
nc	7
nop	1
dl	0
loc	16
ccs	0
cts	16
cp	0
crap	56
rs	8.2222

<?php
/**
 * Created by Gorlum 29.07.2016 13:18
 */

namespace V2Unit;

/**
 * Class V2UnitModel
 *
 * Second iteration of revised Unit
 *
 * @method V2UnitContainer getContainer()
 *
 * @package V2Unit
 *
 */

class V2UnitModel extends \EntityModel {
  /**
   * Name of table for this entity
   *
   * @var string $tableName
   */
  protected $tableName = 'unit';
  /**
   * Name of key field field in this table
   *
   * @var string $idField
   */
  protected $idField = 'unit_id';

  protected $exceptionClass = 'EntityException';
  protected $entityContainerClass = 'V2Unit\V2UnitContainer';

  protected $properties = array(
    'dbId'                => array(
      P_DB_FIELD => 'unit_id',
    ),
    'playerOwnerId'       => array(
      P_DB_FIELD => 'unit_player_id',
    ),
    'locationType'        => array(
      P_DB_FIELD => 'unit_location_type',
    ),
    'locationId'          => array(
      P_DB_FIELD => 'unit_location_id',
    ),
    'type'                => array(
      P_DB_FIELD => 'unit_type',
    ),
    'snId'                => array(
      P_DB_FIELD => 'unit_snid',
    ),
    // Order is important!
    // TODO - split dbLevel to level and count
    'level'               => array(
      P_DB_FIELD => 'unit_level',
    ),
    'count'               => array(),
    // TODO - move to child class
    'timeStart'           => array(
      P_DB_FIELD => 'unit_time_start',
    ),
    'timeFinish'          => array(
      P_DB_FIELD => 'unit_time_finish',
    ),
    // Do we need it? Or internal no info/getters/setters should be ignored?
    'unitInfo'            => array(),
    'isStackable'         => array(),
    'locationDefaultType' => array(),
    'bonusType'           => array(),
  );

  public function __construct(\Common\GlobalContainer $gc) {
    parent::__construct($gc);

    $this->assignAccessor('type', P_CONTAINER_SET, array($this, 'setType'));
    $this->assignAccessor('type', P_CONTAINER_UNSET, array($this, 'unsetType'));

    // This crap code is until php 5.4+. There we can use $this binding for lambdas
    $propertyName = 'timeStart';
    $this->assignAccessor($propertyName, P_CONTAINER_IMPORT, array($gc->types, 'dateTimeImport'));
    $this->assignAccessor($propertyName, P_CONTAINER_EXPORT, array($gc->types, 'dateTimeExport'));

    $propertyName = 'timeFinish';
    $this->assignAccessor($propertyName, P_CONTAINER_IMPORT, array($gc->types, 'dateTimeImport'));
    $this->assignAccessor($propertyName, P_CONTAINER_EXPORT, array($gc->types, 'dateTimeExport'));
  }

  public function setType(V2UnitContainer $that, $value) {
    $that->setDirect('type', $value);
    $array = get_unit_param($value);
    $that->unitInfo = $array;
    // Mandatory
    $that->isStackable = empty($array[P_STACKABLE]) ? false : true;
    $that->locationDefaultType = empty($array[P_LOCATION_DEFAULT]) ? LOC_NONE : $array[P_LOCATION_DEFAULT];
    // Optional
    $that->bonusType = empty($array[P_BONUS_TYPE]) ? BONUS_NONE : $array[P_BONUS_TYPE];
    $that->features = array(); //new FeatureList();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
  }

  public function unsetType(V2UnitContainer $that, $value) {

    unset($that->type);
    unset($that->unitInfo);
    // Mandatory
    unset($that->isStackable);
    unset($that->locationDefaultType);
    // Optional
    unset($that->bonusType);
    unset($that->features);
  }

  /**
   * @param V2UnitContainer $unitCaptain
   * @param int|string      $userId
   *
   * @throws \EntityException
   */
  // TODO - move to unitCaptain
  public function validateCaptainVsUser($unitCaptain, $userId) {
    if (!is_object($unitCaptain) || $this->isNew($unitCaptain) || $this->isEmpty($unitCaptain)) {
      throw new $this->$exceptionClass('module_unit_captain_error_not_found', ERR_ERROR);
    }
    if ($unitCaptain->snId != UNIT_CAPTAIN) {
      throw new $this->$exceptionClass('module_unit_captain_error_wrong_unit', ERR_ERROR);
    }
    if ($unitCaptain->playerOwnerId != $userId) {
      throw new $this->$exceptionClass('module_unit_captain_error_wrong_captain', ERR_ERROR);
    }
    if ($unitCaptain->locationType != LOC_PLANET) {
      throw new $this->$exceptionClass('module_unit_captain_error_wrong_location', ERR_ERROR);
    }
  }

  /**
   * @param V2UnitContainer $cUnit
   *
   * @return bool
   */
  public function isEmpty($cUnit) {
    return
      empty($cUnit->playerOwnerId)
      ||
      is_null($cUnit->locationType)
      ||
      $cUnit->locationType === LOC_NONE
      ||
      empty($cUnit->locationId)
      ||
      empty($cUnit->type)
      ||
      empty($cUnit->snId)
      ||
      empty($cUnit->level);
  }

}


1			<?php
2			/**
3			* Created by Gorlum 29.07.2016 13:18
4			*/
5
6			namespace V2Unit;
7
8			/**
9			* Class V2UnitModel
10			*
11			* Second iteration of revised Unit
12			*
13			* @method V2UnitContainer getContainer()
14			*
15			* @package V2Unit
16			*
17			*/
18
19			class V2UnitModel extends \EntityModel {
20			/**
21			* Name of table for this entity
22			*
23			* @var string $tableName
24			*/
25			protected $tableName = 'unit';
26			/**
27			* Name of key field field in this table
28			*
29			* @var string $idField
30			*/
31			protected $idField = 'unit_id';
32
33			protected $exceptionClass = 'EntityException';
34			protected $entityContainerClass = 'V2Unit\V2UnitContainer';
35
36			protected $properties = array(
37			'dbId' => array(
38			P_DB_FIELD => 'unit_id',
39			),
40			'playerOwnerId' => array(
41			P_DB_FIELD => 'unit_player_id',
42			),
43			'locationType' => array(
44			P_DB_FIELD => 'unit_location_type',
45			),
46			'locationId' => array(
47			P_DB_FIELD => 'unit_location_id',
48			),
49			'type' => array(
50			P_DB_FIELD => 'unit_type',
51			),
52			'snId' => array(
53			P_DB_FIELD => 'unit_snid',
54			),
55			// Order is important!
56			// TODO - split dbLevel to level and count
57			'level' => array(
58			P_DB_FIELD => 'unit_level',
59			),
60			'count' => array(),
61			// TODO - move to child class
62			'timeStart' => array(
63			P_DB_FIELD => 'unit_time_start',
64			),
65			'timeFinish' => array(
66			P_DB_FIELD => 'unit_time_finish',
67			),
68			// Do we need it? Or internal no info/getters/setters should be ignored?
69			'unitInfo' => array(),
70			'isStackable' => array(),
71			'locationDefaultType' => array(),
72			'bonusType' => array(),
73			);
74
75			public function __construct(\Common\GlobalContainer $gc) {
76			parent::__construct($gc);
77
78			$this->assignAccessor('type', P_CONTAINER_SET, array($this, 'setType'));
79			$this->assignAccessor('type', P_CONTAINER_UNSET, array($this, 'unsetType'));
80
81			// This crap code is until php 5.4+. There we can use $this binding for lambdas
82			$propertyName = 'timeStart';
83			$this->assignAccessor($propertyName, P_CONTAINER_IMPORT, array($gc->types, 'dateTimeImport'));
84			$this->assignAccessor($propertyName, P_CONTAINER_EXPORT, array($gc->types, 'dateTimeExport'));
85
86			$propertyName = 'timeFinish';
87			$this->assignAccessor($propertyName, P_CONTAINER_IMPORT, array($gc->types, 'dateTimeImport'));
88			$this->assignAccessor($propertyName, P_CONTAINER_EXPORT, array($gc->types, 'dateTimeExport'));
89			}
90
91			public function setType(V2UnitContainer $that, $value) {
92			$that->setDirect('type', $value);
93			$array = get_unit_param($value);
94			$that->unitInfo = $array;
95			// Mandatory
96			$that->isStackable = empty($array[P_STACKABLE]) ? false : true;
97			$that->locationDefaultType = empty($array[P_LOCATION_DEFAULT]) ? LOC_NONE : $array[P_LOCATION_DEFAULT];
98			// Optional
99			$that->bonusType = empty($array[P_BONUS_TYPE]) ? BONUS_NONE : $array[P_BONUS_TYPE];
100			$that->features = array(); //new FeatureList();
			0 ignored issues – show Documentation introduced 2016-08-13 11:40 UTC by Report Bug Copy Issue Report The property `features` does not exist on `object<V2Unit\V2UnitContainer>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Unused Code Comprehensibility introduced 2016-08-13 11:40 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
101			}
102
103			public function unsetType(V2UnitContainer $that, $value) {
			0 ignored issues – show Unused Code introduced 2016-08-12 20:38 UTC by Report Bug Copy Issue Report The parameter `$value` 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...
104			unset($that->type);
105			unset($that->unitInfo);
106			// Mandatory
107			unset($that->isStackable);
108			unset($that->locationDefaultType);
109			// Optional
110			unset($that->bonusType);
111			unset($that->features);
112			}
113
114			/**
115			* @param V2UnitContainer $unitCaptain
116			* @param int\|string $userId
117			*
118			* @throws \EntityException
119			*/
120			// TODO - move to unitCaptain
121			public function validateCaptainVsUser($unitCaptain, $userId) {
122			if (!is_object($unitCaptain) \|\| $this->isNew($unitCaptain) \|\| $this->isEmpty($unitCaptain)) {
123			throw new $this->$exceptionClass('module_unit_captain_error_not_found', ERR_ERROR);
124			}
125			if ($unitCaptain->snId != UNIT_CAPTAIN) {
126			throw new $this->$exceptionClass('module_unit_captain_error_wrong_unit', ERR_ERROR);
127			}
128			if ($unitCaptain->playerOwnerId != $userId) {
129			throw new $this->$exceptionClass('module_unit_captain_error_wrong_captain', ERR_ERROR);
130			}
131			if ($unitCaptain->locationType != LOC_PLANET) {
132			throw new $this->$exceptionClass('module_unit_captain_error_wrong_location', ERR_ERROR);
133			}
134			}
135
136			/**
137			* @param V2UnitContainer $cUnit
138			*
139			* @return bool
140			*/
141			public function isEmpty($cUnit) {
142			return
143			empty($cUnit->playerOwnerId)
144			\|\|
145			is_null($cUnit->locationType)
146			\|\|
147			$cUnit->locationType === LOC_NONE
148			\|\|
149			empty($cUnit->locationId)
150			\|\|
151			empty($cUnit->type)
152			\|\|
153			empty($cUnit->snId)
154			\|\|
155			empty($cUnit->level);
156			}
157
158			}
159

supernova-ws / SuperNova

Push — work-fleets ( 9e987d...ec9dc8 )

V2UnitModel::isEmpty() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like