alsvanzelf\jsonapi\objects\AttributesObject

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	fromArray()	11	11	2
A	fromObject()	5	5	1
A	add()	9	9	2
A	getKeys()	3	3	1
A	isEmpty()	3	3	2
A	toArray()	3	3	1

<?php

namespace alsvanzelf\jsonapi\objects;

use alsvanzelf\jsonapi\helpers\AtMemberManager;
use alsvanzelf\jsonapi\helpers\Converter;
use alsvanzelf\jsonapi\helpers\Validator;
use alsvanzelf\jsonapi\interfaces\ObjectInterface;

class AttributesObject implements ObjectInterface {

Missing doc comment for class AttributesObject

This class seems to be duplicated in your project.

	use AtMemberManager;
	
	/** @var array */
	protected $attributes = [];
	
	/**
	 * human api
	 */
	
	/**
	 * @note if an `id` is set inside $attributes, it is removed from there
	 *       it is common to find it inside, and not doing so will cause an exception
	 * 
	 * @param  array $attributes

Missing parameter comment

	 * @return AttributesObject
	 */
	public static function fromArray(array $attributes) {
		unset($attributes['id']);
		
		$attributesObject = new self();
		
		foreach ($attributes as $key => $value) {
			$attributesObject->add($key, $value);
		}
		
		return $attributesObject;
	}
	
	/**
	 * @param  object $attributes

Missing parameter comment

	 * @return AttributesObject
	 */
	public static function fromObject($attributes) {
		$array = Converter::objectToArray($attributes);
		
		return self::fromArray($array);
	}
	
	/**
	 * spec api
	 */
	
	/**
	 * @param string $key

Missing parameter comment

	 * @param mixed  $value

Missing parameter comment

	 */

Missing @return tag in function comment

	public function add($key, $value) {
		Validator::checkMemberName($key);
		
		if (is_object($value)) {
			$value = Converter::objectToArray($value);
		}
		
		$this->attributes[$key] = $value;
	}
	
	/**
	 * internal api
	 */
	
	/**
	 * @internal
	 * 
	 * @return string[]

Should the return type not be array<integer|string>?

	 */
	public function getKeys() {
		return array_keys($this->attributes);
	}
	
	/**
	 * ObjectInterface
	 */
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function isEmpty() {
		return ($this->attributes === [] && $this->hasAtMembers() === false);
	}
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function toArray() {
		return array_merge($this->getAtMembers(), $this->attributes);
	}
}