Charcoal\Model\MetadataLoaderAwareTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setMetadataLoader()	0	3	1
A	metadataLoader()	0	10	2
A	loadMetadata()	0	6	1

<?php

namespace Charcoal\Model;

use RuntimeException;

use Charcoal\Model\Service\MetadataLoader;

/**
 * Provides describable metadata features.
 *
 * Metadata Loader Aware Trait
 * @package Charcoal\Model
 */
trait MetadataLoaderAwareTrait
{
    /**
     * Store the metadata loader.
     *
     * @var MetadataLoader
     */
    protected $metadataLoader;

    /**
     * Set a metadata loader.
     *
     * @param  MetadataLoader $loader The metadata loader.
     * @return void
     */
    protected function setMetadataLoader(MetadataLoader $loader)
    {
        $this->metadataLoader = $loader;
    }

    /**
     * Retrieve the metadata loader.
     *
     * @throws RuntimeException If the metadata loader is missing.
     * @return MetadataLoader
     */
    public function metadataLoader()
    {
        if (!isset($this->metadataLoader)) {
            throw new RuntimeException(sprintf(
                'Metadata Loader is not defined for [%s]',
                get_class($this)
            ));
        }

        return $this->metadataLoader;
    }

    /**
     * Load a metadata file.
     *
     * @param  string $metadataIdent A metadata file path or namespace.
     * @return MetadataInterface
     */
    protected function loadMetadata($metadataIdent)
    {
        $metadataLoader = $this->metadataLoader();
        $metadata = $metadataLoader->load($metadataIdent, $this->createMetadata());

        return $metadata;

The expression return $metadata also could return the type array which is incompatible with the documented return type Charcoal\Model\MetadataInterface.

    }

    /**
     * Retrieve a new metadata object.
     *
     * @return MetadataInterface
     */
    abstract protected function createMetadata();
}