Charcoal\Source\ModelAwareTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setModel()	0	4	1
A	model()	0	8	2
A	hasModel()	0	3	1

<?php

namespace Charcoal\Source;

use RuntimeException;

// From 'charcoal-core'
use Charcoal\Model\ModelInterface;

/**
 * Provides awareness for an object model.
 */
trait ModelAwareTrait
{
    /**
     * The source's object model.
     *
     * @var ModelInterface
     */
    private $model;

    /**
     * Set the source's model.
     *
     * @param ModelInterface $model The source's model.
     * @return self
     */
    public function setModel(ModelInterface $model)
    {
        $this->model = $model;
        return $this;
    }

    /**
     * Retrieve the source's model.
     *
     * @throws RuntimeException If not model was previously set.
     * @return ModelInterface
     */
    public function model()
    {
        if ($this->model === null) {
            throw new RuntimeException(
                'Model is missing for source.'
            );
        }
        return $this->model;
    }

    /**
     * Determine if the source has a model.
     *
     * @return boolean
     */
    public function hasModel()
    {
        return ($this->model !== null);
    }
}