tapestry-cloud/tapestry

View on GitHub
src/Modules/ContentTypes/ContentTypeFactory.php

Summary

Maintainability
A
0 mins
Test Coverage
B
87%
<?php

namespace Tapestry\Modules\ContentTypes;

use Tapestry\Entities\ContentType;

class ContentTypeFactory
{
    /**
     * Registered item stack.
     *
     * @var array|ContentType[]
     */
    private $items = [];

    /**
     * Registered item lookup table.
     *
     * @var array
     */
    private $pathLookupTable = [];

    /**
     * Registered items name lookup table.
     *
     * @var array
     */
    private $nameLookupTable = [];

    /**
     * ContentTypeFactory constructor.
     *
     * @param array|ContentType[] $items
     */
    public function __construct(array $items = [])
    {
        foreach ($items as $item) {
            $this->add($item);
        }
    }

    /**
     * Add a ContentType to the registry.
     *
     * @param ContentType $contentType
     * @param bool        $overWrite   should adding overwrite existing; if false an exception will be thrown if a matching collection already found
     *
     * @throws \Exception
     */
    public function add(ContentType $contentType, $overWrite = false)
    {
        if (! $overWrite && $this->has($contentType->getPath())) {
            throw new \Exception('The collection ['.$this->pathLookupTable[$contentType->getPath()].'] already collects for the path ['.$contentType->getPath().']');
        }
        $uid = sha1(md5(get_class($contentType)).'_'.sha1($contentType->getName().'-'.$contentType->getPath()));
        $this->items[$uid] = $contentType;
        $this->pathLookupTable[$contentType->getPath()] = $uid;
        $this->nameLookupTable[$contentType->getName()] = $uid;
    }

    /**
     * Return true if the registry contains an absolute path.
     *
     * @param string $path
     *
     * @return bool
     */
    public function has($path)
    {
        return isset($this->pathLookupTable[$path]);
    }

    /**
     * Return all ContentTypes registered with this factory.
     *
     * @return array|\Tapestry\Entities\ContentType[]
     */
    public function all()
    {
        return array_values($this->items);
    }

    /**
     * Returns the absolute path from an input, so that you may then get the ContentType that deals with it.
     *
     * @param string $path
     *
     * @return null|string
     */
    public function find($path)
    {
        foreach (array_keys($this->pathLookupTable) as $key) {
            if (starts_with($path, $key)) {
                return $key;
            }
        }
    }

    /**
     * Get ContentType by its supported path. If $path is '*' then if a default ContentType has been set it will be
     * returned.
     *
     * @param string $path
     *
     * @throws \Exception
     *
     * @return ContentType
     */
    public function get($path)
    {
        if (! $this->has($path) && ! $this->has('*')) {
            throw new \Exception('There is no collection that collects for the path ['.$path.']');
        }

        if (! $this->has($path) && $this->has('*')) {
            return $this->items[$this->pathLookupTable['*']];
        }

        return $this->items[$this->pathLookupTable[$path]];
    }

    /**
     * ArrayAccess method for use by ArrayContainer for dot notation key retrieval.
     *
     * @param $key
     *
     * @return mixed|null|ContentType
     */
    public function arrayAccessByKey($key)
    {
        if (! isset($this->nameLookupTable[$key])) {
            return null;
        }

        if (isset($this->items[$this->nameLookupTable[$key]])) {
            return $this->items[$this->nameLookupTable[$key]];
        }

        return null;
    }
}