Metadata\Cache\FileCache

Complexity

Total Complexity

15

Size/Duplication

Total Lines	91
Duplicated Lines	17.58 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	7
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	3
A	putClassMetadataInCache()	0	12	1
B	renameFile()	0	14	5
A	evictClassMetadataFromCache()	7	7	2
A	loadClassMetadataFromCache()	9	9	2
A	escapeFileName()	0	9	2

<?php

namespace Metadata\Cache;

use Metadata\ClassMetadata;

Copyright notice missing

class FileCache implements CacheInterface

Missing class doc comment

{
    private $dir;

Tabs must be used to indent lines; spaces are not allowed

    public function __construct($dir)

Missing function doc comment

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        if (!is_dir($dir)) {

Tabs must be used to indent lines; spaces are not allowed

            throw new \InvalidArgumentException(sprintf('The directory "%s" does not exist.', $dir));

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        if (!is_writable($dir)) {

Tabs must be used to indent lines; spaces are not allowed

            throw new \InvalidArgumentException(sprintf('The directory "%s" is not writable.', $dir));

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        $this->dir = rtrim($dir, '\\/');

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Doc comment for parameter "$class" missing

Tabs must be used to indent lines; spaces are not allowed

     * {@inheritDoc}

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    public function loadClassMetadataFromCache(\ReflectionClass $class)

This method seems to be duplicated in your project.

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $path = $this->dir.'/'.$this->escapeFileName($class->name).'.cache.php';

Concat operator must be surrounded by spaces.

Tabs must be used to indent lines; spaces are not allowed

        if (!@file_exists($path)) {

Tabs must be used to indent lines; spaces are not allowed

            return null;

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        return include $path;

Including files with "include" is not allowed; use "require_once" instead

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Doc comment for parameter "$metadata" missing

Tabs must be used to indent lines; spaces are not allowed

     * {@inheritDoc}

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    public function putClassMetadataInCache(ClassMetadata $metadata)

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $path = $this->dir.'/'.$this->escapeFileName($metadata->name).'.cache.php';

Concat operator must be surrounded by spaces.

Tabs must be used to indent lines; spaces are not allowed

        $tmpFile = tempnam($this->dir, 'metadata-cache');

Tabs must be used to indent lines; spaces are not allowed

        file_put_contents($tmpFile, '<?php return unserialize('.var_export(serialize($metadata), true).');');

Concat operator must be surrounded by spaces.

Tabs must be used to indent lines; spaces are not allowed

Tabs must be used to indent lines; spaces are not allowed

        // Let's not break filesystems which do not support chmod.

Tabs must be used to indent lines; spaces are not allowed

        @chmod($tmpFile, 0666 & ~umask());

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

Tabs must be used to indent lines; spaces are not allowed

        $this->renameFile($tmpFile, $path);

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Renames a file with fallback for windows

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @param string $source

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     * @param string $target

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    private function renameFile($source, $target) {

Tabs must be used to indent lines; spaces are not allowed

        if (false === @rename($source, $target)) {

Tabs must be used to indent lines; spaces are not allowed

            if (defined('PHP_WINDOWS_VERSION_BUILD')) {

Tabs must be used to indent lines; spaces are not allowed

                if (false === copy($source, $target)) {

Tabs must be used to indent lines; spaces are not allowed

                    throw new \RuntimeException(sprintf('(WIN) Could not write new cache file to %s.', $target));

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

                if (false === unlink($source)) {

Tabs must be used to indent lines; spaces are not allowed

                    throw new \RuntimeException(sprintf('(WIN) Could not delete temp cache file to %s.', $source));

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

            } else {

Tabs must be used to indent lines; spaces are not allowed

                throw new \RuntimeException(sprintf('Could not write new cache file to %s.', $target));

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Doc comment for parameter "$class" missing

Tabs must be used to indent lines; spaces are not allowed

     * {@inheritDoc}

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    public function evictClassMetadataFromCache(\ReflectionClass $class)

This method seems to be duplicated in your project.

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $path = $this->dir.'/'.$this->escapeFileName($class->name).'.cache.php';

Concat operator must be surrounded by spaces.

Tabs must be used to indent lines; spaces are not allowed

        if (file_exists($path)) {

Tabs must be used to indent lines; spaces are not allowed

            unlink($path);

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param string $fileName

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     * @return string

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    private function escapeFileName($fileName)

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $match = [];

Tabs must be used to indent lines; spaces are not allowed

        // Support anonymous classes

Tabs must be used to indent lines; spaces are not allowed

        if (preg_match('/([\w\d]+?\.php.*)$/', $fileName, $match)) {

Tabs must be used to indent lines; spaces are not allowed

            $fileName = $match[1];

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        return strtr($fileName, '\\', '-');

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

}