Naneau\FileGen\File\Contents\StringBased

Complexity

Total Complexity

3

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getContents()	0	4	1
A	setContents()	0	6	1

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

use Naneau\FileGen\File\Contents;

/**
 * String based file contents
 */
class StringBased implements Contents
{
    /**
     * Contents of the file
     *
     * @var string
     **/
    private $contents;

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

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

    /**
     * Set the contents of the file
     *
     * @param  ContentGenerator|string $contents
     * @return self
     */
    public function setContents($contents)
    {
        $this->contents = $contents;

It seems like $contents can also be of type object<Naneau\FileGen\File\Contents\ContentGenerator>. However, the property $contents is declared as type string. Maybe add an additional type check?

        return $this;
    }
}