EoC\Doc\TDoc

Complexity

Total Complexity

36

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
	fixDocId()	0	1	?
	getPath()	0	1	?
A	resetMetadata()	0	4	1
A	getMetadata()	0	3	1
A	isMetadataPresent()	0	3	2
B	setMetadata()	0	9	5
A	unsetMetadata()	0	4	2
A	setClass()	0	3	1
A	setType()	0	3	1
A	getType()	0	3	1
A	hasType()	0	3	1
A	assignJson()	0	4	1
A	assignArray()	0	8	2
A	assignObject()	0	4	1
A	asJson()	0	10	2
A	asArray()	0	3	1
A	delete()	0	3	1
A	isDeleted()	0	3	1
A	getRevisions()	0	3	2
A	getId()	0	3	1
A	issetId()	0	3	1
A	setId()	0	3	1
A	unsetId()	0	4	2
A	getRev()	0	3	1
A	issetRev()	0	3	1
A	setRev()	0	3	1
A	unsetRev()	0	4	2

<?php

/**
 * @file TDoc.php
 * @brief This file contains the TDoc trait.
 * @details
 * @author Filippo F. Fadda
 */


namespace EoC\Doc;


use EoC\Extension\TProperty;
use EoC\Helper;


/**
 * @brief Implements the IDoc interface and add many functions.
 * @see AbstractDoc.dox
 */
trait TDoc {
  use TProperty;

  protected $meta = [];


  abstract protected function fixDocId();


  abstract public function getPath();


  public function resetMetadata() {
    unset($this->meta);
    $this->meta = [];
  }


  public function getMetadata($name) {
    return @$this->meta[$name];
  }


  public function isMetadataPresent($name) {
    return (array_key_exists($name, $this->meta)) ? TRUE : FALSE;
  }


  public function setMetadata($name, $value, $override = TRUE, $allowNull = TRUE) {
    if (is_null($value) && !$allowNull)
      return;

    if ($this->isMetadataPresent($name) && !$override)
      return;

    $this->meta[$name] = $value;
  }


  public function unsetMetadata($name) {
    if (array_key_exists($name, $this->meta))
      unset($this->meta[$name]);
  }


  public function setClass($value) {
    $this->meta['class'] = $value;
  }


  public function setType($value) {
    $this->meta['type'] = $value;
  }


  public function getType() {
    return $this->meta['type'];
  }


  public function hasType() {
    return FALSE;
  }


  public function assignJson($json) {
    $this->meta = array_merge($this->meta, Helper\ArrayHelper::fromJson($json, TRUE));
    $this->fixDocId();
  }


  public function assignArray(array $array) {
    if (Helper\ArrayHelper::isAssociative($array)) {
      $this->meta = array_merge($this->meta, $array);
      $this->fixDocId();
    }
    else
      throw new \InvalidArgumentException("\$array must be an associative array.");
  }


  public function assignObject(\stdClass $object) {
    $this->meta = array_merge($this->meta, get_object_vars($object));
    $this->fixDocId();
  }


  public function asJson() {
    $json = json_encode($this->meta,
        JSON_UNESCAPED_UNICODE |
        JSON_PARTIAL_OUTPUT_ON_ERROR |
        JSON_PRESERVE_ZERO_FRACTION
    );

    if ($json === FALSE)
      throw new \RuntimeException(json_last_error_msg());
  }


  public function asArray() {
    return $this->meta;
  }


  public function delete() {
    $this->meta['_deleted'] = TRUE;
  }


  public function isDeleted() {
    return $this->meta['_deleted'];
  }


  public function getRevisions() {
    return (array_key_exists('_revisions', $this->meta)) ? $this->meta['_revisions'] : NULL;
  }


  public function getId() {
    return $this->meta['_id'];
  }


  public function issetId() {
    return isset($this->meta['_id']);
  }


  public function setId($value) {
    $this->meta['_id'] = (string)$value;
  }


  public function unsetId() {
    if ($this->isMetadataPresent('_id'))
      unset($this->meta['_id']);
  }


  public function getRev() {
    return $this->meta['_rev'];
  }


  public function issetRev() {
    return isset($this->meta['_rev']);
  }


  public function setRev($value) {
    $this->meta['_rev'] = (string)$value;
  }


  public function unsetRev() {
    if ($this->isMetadataPresent('_rev'))
      unset($this->meta['_rev']);
  }

}