allejo\stakx\Document\ReadableDocument

Complexity

Total Complexity

6

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getRelativeFilePath()	0	4	1
A	getExtension()	0	4	1
A	getBaseName()	0	4	1
A	getFilePath()	0	4	1
A	getFileName()	0	4	1
	refreshFileContent()	0	1	?

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Document;

use allejo\stakx\System\Filesystem;
use Symfony\Component\Filesystem\Exception\FileNotFoundException;

abstract class ReadableDocument

ReadableDocument does not seem to conform to the naming convention (^Abstract|Factory$).

{
    protected $filePath;
    protected $extension;
    protected $fs;

Avoid variables with short names like $fs. Configured minimum length is 3.

    public function __construct($filePath)
    {
        $this->fs = new Filesystem();
        $p = $this->filePath = $this->fs->absolutePath((string)$filePath);

Avoid variables with short names like $p. Configured minimum length is 3.

        $this->extension = strtolower($this->fs->getExtension($p));
        $this->refreshFileContent();
    }

    final public function getRelativeFilePath()
    {
        return $this->fs->getRelativePath($this->filePath);
    }

    final public function getExtension()
    {
        return $this->extension;
    }

    final public function getBaseName()
    {
        return $this->fs->getBaseName($this->filePath);
    }

    final public function getFilePath()
    {
        return $this->filePath;
    }

    final public function getFileName()
    {
        return $this->fs->getFileName($this->filePath);
    }

    abstract public function refreshFileContent();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}