allejo\stakx\Markup\AssetHandlerTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileFromPath()	0	8	1
A	getPermalinkFromFile()	0	6	1
A	isValidURL()	0	4	1
A	registerAsset()	0	12	2

<?php

namespace allejo\stakx\Markup;

use allejo\stakx\Document\ContentItem;
use allejo\stakx\Filesystem\File;
use allejo\stakx\Filesystem\FilesystemLoader as fs;
use allejo\stakx\Manager\AssetManager;

/**
 * This trait provides the functionality for registering linked files with our AssetManager.
 *
 * @since 0.2.1
 */
trait AssetHandlerTrait
{
    /** @var AssetManager */
    protected $assetManager;

    /** @var ContentItem */
    protected $contentItem;

    /**
     * Get a File object from a local path relative to the ContentItem.
     *
     * @param string $localPath
     *
     * @return File
     */
    private function getFileFromPath($localPath)
    {
        $path = fs::path($this->contentItem->getAbsoluteFilePath())
            ->getParentDirectory()
            ->generatePath($localPath);

        return new File($path);
    }

    /**
     * Get the permalink this file would belong at.
     *
     * This is taken from the ContentItem's target path and puts the asset at the same location as a sibling.
     *
     * @param File $file
     *
     * @return string

Should the return type not be \string?

     */
    private function getPermalinkFromFile(File $file)
    {
        $folder = fs::path($this->contentItem->getTargetFile())->getParentDirectory();

        return fs::getRelativePath($folder->generatePath($file->getFilename()));

$folder->generatePath($file->getFilename()) is of type object<allejo\stakx\Filesystem\FilesystemPath>, but the function expects a object<string>.

    }

    /**
     * Check if a given string is a valid URL.
     *
     * @param string $url
     *
     * @return bool
     */
    private function isValidURL($url)
    {
        return filter_var($url, FILTER_VALIDATE_URL);
    }

    /**
     * Given a URL to a local path, register this function with the AssetManager so it can be available at compile time.
     *
     * @since 0.2.1
     *
     * @param string $path
     *
     * @return void
     */
    protected function registerAsset($path)
    {
        if ($this->isValidURL($path))
        {
            return;
        }

        $asset = $this->getFileFromPath($path);
        $permalink = $this->getPermalinkFromFile($asset);

        $this->assetManager->addExplicitAsset($permalink, $asset);
    }
}