Naneau\ProjectVersioner\Reader\File

Complexity

Total Complexity

5

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	canRead()	0	4	1
A	read()	0	4	1
A	getFile()	0	4	1
A	setFile()	0	6	1

<?php
/**
 * File.php
 *
 * @package         ProjectVersioner
 * @subpackage      Reader
 */

namespace Naneau\ProjectVersioner\Reader;

use Naneau\ProjectVersioner\ReaderInterface;

/**
 * File
 *
 * Reads a version from a file
 *
 * @category        Naneau
 * @package         ProjectVersioner
 * @subpackage      Reader
 */
class File implements ReaderInterface
{
    /**
     * The file
     *
     * @var string
     **/
    private $file;

    /**
     * Constructor
     *
     * @param  string $file version 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($file)
    {
        $this->setFile($file);
    }

    /**
     * {@inheritdoc}
     **/
    public function canRead($directory)
    {
        return is_readable($directory . DIRECTORY_SEPARATOR . $this->getFile());
    }

    /**
     * {@inheritdoc}
     **/
    public function read($directory)
    {
        return trim(file_get_contents($directory . DIRECTORY_SEPARATOR . $this->getFile()));
    }

    /**
     * Get the file
     *
     * @return string
     */
    public function getFile()
    {
        return $this->file;
    }

    /**
     * Set the file
     *
     * @param  string $file
     * @return parent
     */
    public function setFile($file)
    {
        $this->file = $file;

        return $this;
    }

}