Thinktomorrow\Squanto\Domain\LineKey

Complexity

Total Complexity

13

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	fromString()	0	4	1
A	get()	0	4	1
A	getAsLabel()	0	9	1
A	getPageKey()	0	4	1
A	isExcludedSource()	0	6	1
A	sanitizeKey()	0	4	1
A	validateKey()	0	6	4
A	getExcludedSources()	0	9	2

<?php

namespace Thinktomorrow\Squanto\Domain;

use Thinktomorrow\Squanto\Exceptions\InvalidLineKeyException;

class LineKey
{
    private static $excludedSources;
    private $key;

    public function __construct($key)
    {
        $this->validateKey($key);

        $this->key = $this->sanitizeKey($key);
    }

    public static function fromString($key)
    {
        return new self($key);
    }

    public function get()
    {
        return $this->key;
    }

    /**
     * Get suggestion for a label based on the key
     *
     * @return string
     */
    public function getAsLabel()
    {
        // Remove first part since that part equals the page
        $key = substr($this->key, strpos($this->key, '.')+1);

        $label = str_replace('.', ' ', $key);

        return ucfirst($label);
    }

    /**
     * Get Page identifier.
     * This is the first segment of the key
     *
     * @return string
     */
    public function getPageKey()
    {
        return substr($this->key, 0, strpos($this->key, '.'));
    }

    public function isExcludedSource()
    {
        $excluded = $this->getExcludedSources();

        return in_array($this->getPageKey(),$excluded);
    }

    private function sanitizeKey($key)
    {
        return strtolower($key);
    }

    private function validateKey($key)
    {
        if (!$key || !is_string($key) || false === strpos($key, '.')) {
            throw new InvalidLineKeyException('Invalid LineKey format ['.$key.', type: '.gettype($key).'] given. Must be a string containing at least two dot separated segments. E.g. about.title');
        }
    }

    private function getExcludedSources()
    {
        if(!self::$excludedSources)
        {
            self::$excludedSources = config('squanto.excluded_files',[]);
        }

        return self::$excludedSources;
    }

}