JonnyW\PhantomJs\Validator\Esprima

Complexity

Total Complexity

6

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

87.5%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	toString()	0	6	1
A	loadFile()	0	4	1
A	__toString()	0	4	1
A	load()	0	11	2

<?php

/*
 * This file is part of the php-phantomjs.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace JonnyW\PhantomJs\Validator;

use Symfony\Component\Config\FileLocatorInterface;

/**
 * PHP PhantomJs
 *
 * @author Jon Wenmoth <contact@jonnyw.me>
 */
class Esprima implements EngineInterface
{
    /**
     * File locator
     *
     * @var \Symfony\Component\Config\FileLocatorInterface
     * @access protected
     */
    protected $locator;

    /**
     * Esprima file.
     *
     * @var string
     * @access protected
     */
    protected $file;

    /**
     * Esprima script.
     *
     * @var string
     * @access protected
     */
    protected $esprima;

    /**
     * Internal constructor.
     *
     * @access public
     * @param  \Symfony\Component\Config\FileLocatorInterface $locator
     * @param  string                                         $file
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($locator, $file)
    {
        $this->locator = $locator;
        $this->file    = $file;
    }

    /**
     * Returns engine as string.
     *
     * @access public
     * @return string
     */
    public function toString()
    {
        $this->load();

        return $this->esprima;
    }

    /**
     * To string magic method.
     *
     * @access public
     * @return string
     */
    public function __toString()
    {
        return $this->toString();
    }

    /**
     * Load esprima script.
     *
     * @access public
     * @return string
     */
    public function load()
    {
        if (!$this->esprima) {

            $this->esprima = $this->loadFile(
                $this->locator->locate($this->file)

It seems like $this->locator->locate($this->file) targeting Symfony\Component\Config\FileLocatorInterface::locate() can also be of type array; however, JonnyW\PhantomJs\Validator\Esprima::loadFile() does only seem to accept string, maybe add an additional type check?

            );
        }

        return $this->esprima;
    }

    /**
     * Load procedure file content.
     *
     * @access protected
     * @param  string $file
     * @return string
     */
    protected function loadFile($file)
    {
        return file_get_contents($file);
    }
}