gossi\codegen\model\AbstractModel

Complexity

Total Complexity

12

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	2	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	setDescription()	0	7	2
A	setAttribute()	0	5	1
A	removeAttribute()	0	5	1
A	getAttribute()	0	7	2
A	getAttributeOrElse()	0	7	2
A	hasAttribute()	0	3	1
A	setAttributes()	0	5	1
A	getAttributes()	0	3	1

<?php
namespace gossi\codegen\model;

/**
 * Parent of all models
 *
 * @author Thomas Gossmann
 */
abstract class AbstractModel {

	/** @var array */
	private $attributes = [];

	/** @var string */
	protected $description;

	/**
	 * Sets a custom user attribute
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @param string $key
	 * @param mixed $value
	 * @return $this
	 */
	public function setAttribute($key, $value) {
		$this->attributes[$key] = $value;

		return $this;
	}

	/**
	 * Removes and returns a custom user attribute
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @param string $key
	 * @return mixed
	 */
	public function removeAttribute($key) {
		$val = $this->attributes[$key];
		unset($this->attributes[$key]);
		return $val;
	}

	/**
	 * Returns a custom user attribute
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @param string $key
	 * @throws \InvalidArgumentException if the key cannot be found
	 * @return mixed
	 */
	public function getAttribute($key) {
		if (!isset($this->attributes[$key])) {
			throw new \InvalidArgumentException(sprintf('There is no attribute named "%s".', $key));
		}

		return $this->attributes[$key];
	}

	/**
	 * Returns a custom user attribute or the default value if the attribute doesn't exist
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @param string $key
	 * @param mixed $default
	 * @return mixed
	 */
	public function getAttributeOrElse($key, $default) {
		if (!isset($this->attributes[$key])) {
			return $default;
		}

		return $this->attributes[$key];
	}

	/**
	 * Checks whether an attribute exists
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @param string $key
	 * @return bool
	 */
	public function hasAttribute($key) {
		return isset($this->attributes[$key]);
	}

	/**
	 * Sets custom user attributes
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @param array $attrs
	 * @return $this
	 */
	public function setAttributes(array $attrs) {
		$this->attributes = $attrs;

		return $this;
	}

	/**
	 * Returns all custom user attributes
	 *
	 * @deprecated See: https://github.com/gossi/php-code-generator/issues/29
	 * @return array
	 */
	public function getAttributes() {
		return $this->attributes;
	}

	/**
	 * Returns this description
	 *
	 * @return string
	 */
	public function getDescription() {
		return $this->description;
	}

	/**
	 * Sets the description, which will also be used when generating a docblock
	 *
	 * @param string|array $description
	 * @return $this
	 */
	public function setDescription($description) {
		if (is_array($description)) {
			$description = implode("\n", $description);
		}
		$this->description = $description;
		return $this;
	}

}