As3\Modlr\Metadata\Traits\AttributesTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	addAttribute()	0	7	1
A	attrSupportsAutocomplete()	0	4	1
A	getAttribute()	0	7	2
A	getAttributes()	0	4	1
A	getAutocompleteAttributes()	0	16	4
A	hasAttribute()	0	4	1
A	hasAttributes()	0	4	1
	validateAttribute()	0	1	?

<?php

namespace As3\Modlr\Metadata\Traits;

use As3\Modlr\Exception\MetadataException;
use As3\Modlr\Metadata\AttributeMetadata;

/**
 * Common attribute metadata get, set, and add methods.
 *
 * @author Jacob Bare <jacob.bare@gmail.com>
 */
trait AttributesTrait
{
    /**
     * All attribute fields assigned to this metadata object.
     * An attribute is a "standard" field, such as a string, integer, array, etc.
     *
     * @var AttributeMetadata[]
     */
    public $attributes = [];

    /**
     * Adds an attribute field.
     *
     * @param   AttributeMetadata   $attribute
     * @return  self
     */
    public function addAttribute(AttributeMetadata $attribute)
    {
        $this->validateAttribute($attribute);
        $this->attributes[$attribute->getKey()] = $attribute;
        ksort($this->attributes);
        return $this;
    }

    /**
     * Determines if an attribute supports autocomplete functionality.
     *
     * @param   string  $key    The attribute key.
     * @return  bool
     */
    public function attrSupportsAutocomplete($key)
    {
        return isset($this->getAutocompleteAttributes()[$key]);
    }

    /**
     * Gets an attribute field.
     * Returns null if the attribute does not exist.
     *
     * @param   string  $key
     * @return  AttributeMetadata|null
     */
    public function getAttribute($key)
    {
        if (!isset($this->attributes[$key])) {
            return null;
        }
        return $this->attributes[$key];
    }

    /**
     * Gets all attribute fields.
     *
     * @return  AttributeMetadata[]
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Gets all properties that are flagged for autocomplete in search.
     *
     * @return  AttributeMetadata[]
     */
    public function getAutocompleteAttributes()
    {
        static $attrs;
        if (null !== $attrs) {
            return $attrs;
        }

        $attrs = [];
        foreach ($this->getAttributes() as $key => $attribute) {
            if (false === $attribute->hasAutocomplete()) {
                continue;
            }
            $attrs[$key] = $attribute;
        }
        return $attrs;
    }

    /**
     * Determines if an attribute field exists.
     *
     * @param   string  $key
     * @return  bool
     */
    public function hasAttribute($key)
    {
        return null !== $this->getAttribute($key);
    }

    /**
     * Determines any attribute fields exist.
     *
     * @return  bool
     */
    public function hasAttributes()
    {
        return !empty($this->attributes);
    }

    /**
     * Validates that the attribute can be added.
     *
     * @param   AttributeMetadata   $attribute
     * @return  self
     * @throws  MetadataException
     */
    abstract protected function validateAttribute(AttributeMetadata $attribute);
}