Helix\DB\AttributesTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetUnset()	0	2	1
A	offsetSet()	0	2	1
A	offsetExists()	0	2	2
A	offsetGet()	0	2	1
A	setAttributes()	0	3	1
A	getAttributes()	0	2	2

<?php

namespace Helix\DB;

/**
 * Forwards `ArrayAccess` to an EAV array property named `$attributes`.
 *
 * `ArrayAccess` must be implemented by the class using this trait.
 * The `$attributes` property must also be defined in the class,
 * and annotated with `@eav TABLE`.
 *
 * The instance must have its attributes loaded before use as an array,
 * otherwise existing EAV data may be lost when the instance is saved.
 * Attribute loading is done automatically by {@link Record}.
 *
 * @see Record::load()
 */
trait AttributesTrait {

    /**
     * Override this property with your own annotation.
     *
     * The property must remain `null` when not in use.
     *
     * @eav EAV_TABLE
     * @var array
     */
    protected $attributes;

    /**
     * @return array
     */
    public function getAttributes (): array {
        return $this->attributes ?: [];
    }

    /**
     * @param mixed $attr
     * @return bool
     */
    public function offsetExists ($attr): bool {
        return $this->attributes and array_key_exists($attr, $this->attributes);
    }

    /**
     * @param mixed $attr
     * @return null|mixed
     */
    public function offsetGet ($attr) {
        return $this->attributes[$attr] ?? null;
    }

    /**
     * @param mixed $attr
     * @param mixed $value
     */
    public function offsetSet ($attr, $value): void {
        $this->attributes[$attr] = $value;
    }

    /**
     * @param mixed $attr
     */
    public function offsetUnset ($attr): void {
        unset($this->attributes[$attr]);
    }

    /**
     * @param array $attributes
     * @return $this
     */
    public function setAttributes (array $attributes) {
        $this->attributes = $attributes;
        return $this;
    }
}