Naneau\FileGen\File\Contents\Copy

Complexity

Total Complexity

7

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getContents()	0	21	4
A	getFrom()	0	4	1
A	setFrom()	0	6	1

<?php
namespace Naneau\FileGen\File\Contents;

use Naneau\FileGen\File\Contents\Exception as ContentsException;
use Naneau\FileGen\File\Contents;

/**
 * Contents for a file copied directly from another
 */
class Copy implements Contents
{
    /**
     * The source file
     *
     * @var string
     **/
    private $from;

    /**
     * The source file
     *
     * @param  string $from
     * @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($from)
    {
        $this->setFrom($from);
    }

    /**
     * Get the contents
     *
     * @return string
     **/
    public function getContents()
    {
        // Make sure file exists
        if (!file_exists($this->getFrom()) || !is_readable($this->getFrom())) {
            throw new ContentsException(sprintf(
                'Can not read from "%s"',
                $this->getFrom()
            ));
        }

        $contents = file_get_contents($this->getFrom());

        if ($contents === false) {
            throw new ContentsException(sprintf(
                'Could not read from "%s"',
                $this->getFrom()
            ));
        }

        return $contents;
    }

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

    /**
     * Set the source file
     *
     * @param  string $from
     * @return Copy
     */
    public function setFrom($from)
    {
        $this->from = $from;

        return $this;
    }
}