Entity\KeyedModel

Complexity

Total Complexity

11

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	12
Bugs	1	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	exportRowNoId()	0	7	2
A	loadById()	0	11	2
A	delete()	0	5	1
A	insert()	0	3	1
A	update()	0	7	1
A	onSaveUnchanged()	0	5	1
A	onSaveNew()	0	5	1
A	getIdFieldName()	0	3	1

<?php
/**
 * Created by Gorlum 19.08.2016 21:26
 */

namespace Entity;

/**
 * Class KeyedModel
 *
 * @method KeyedContainer fromArray($array)
 *
 * @package Entity
 */

class KeyedModel extends EntityModel {
  protected $newProperties = array(
    'dbId' => array(
      P_DB_FIELD => 'id',
    ),
  );

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

  /**
   * Exports object properties to DB row state WITHOUT ID
   *
   * Useful for INSERT operations
   *
   * @param \Entity\KeyedContainer $cEntity
   */
  protected function exportRowNoId($cEntity) {
    $this->exportRow($cEntity);

    if (($idFieldName = $this->getIdFieldName()) != '') {
      unset($cEntity->row[$idFieldName]);
    }
  }

  /**
   * @param int|string $dbId
   *
   * @return KeyedContainer|false
   */
  public function loadById($dbId) {
    $row = $this->rowOperator->getById($this, $dbId);
    if (empty($row)) {
      return false;
    }

    $cEntity = $this->fromArray($row);
    $cEntity->dbStatus = DB_RECORD_LOADED;

    return $cEntity;
  }

  /**
   * @param KeyedContainer $cEntity
   *
   * @throws \Exception
   */
  protected function delete($cEntity) {
    $this->rowOperator->deleteById($this, $cEntity->dbId);
    $cEntity->dbStatus = DB_RECORD_DELETED;
    throw new \Exception('KeyedModel::delete() is not yet implemented');
  }

  /**
   * @param KeyedContainer $cEntity
   */
  protected function insert($cEntity) {
    $cEntity->dbId = $this->rowOperator->insert($this, $this->exportRowNoId($cEntity));

$this->exportRowNoId($cEntity) is of type null, but the function expects a array.

  }

  /**
   * @param KeyedContainer $cEntity
   *
   * @throws \Exception
   */
  protected function update($cEntity) {
    // TODO - separate real changes from internal ones
    // Generate changeset row
    // Foreach all rows. If there is change and no delta - then put delta. Otherwise put change
    // If row not empty - update
    throw new \Exception('KeyedModel::update() is not yet implemented');
  }

  /**
   * @param KeyedContainer $cEntity
   */
  protected function onSaveUnchanged($cEntity){
    // TODO - or just save nothing ?????
    // throw new \Exception('EntityModel isNotEmpty, have dbId and not CHANGED! It can\'t be!');
    // Do nothing
  }

  /**
   * @param KeyedContainer $cEntity
   */
  protected function onSaveNew($cEntity) {
    // Just created container and doesn't use it
//    throw new \Exception('EntityModel isEmpty but not loaded! It can\'t be!');
    // Do nothing
  }

  /**
   * Gets entity's DB ID field name (which is unique within entity set)
   *
   * @return string
   */
  public function getIdFieldName() {
    return $this->properties['dbId'][P_DB_FIELD];
  }

}