naneau / filegen

src/Naneau/FileGen/File.php

<?php
namespace Naneau\FileGen;

use Naneau\FileGen\Parameterized;

use Naneau\FileGen\AccessRights;

use Naneau\FileGen\File\Contents as ContentGenerator;
use Naneau\FileGen\File\Contents\StringBased as StringContents;

use \InvalidArgumentException;

/**
 * A file
 */
class File extends AccessRights
{
    /**
     * Contents of the file
     *
     * @var ContentGenerator
     **/
    private $contentGenerator;

    /**
     * Constructor
     *
     * @param  string                  $name
     * @param  ContentGenerator|string $contents
     * @param  int                     $mode     mode in octal 0XXX
     * @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($name, $contents = '', $mode = null)
    {
        parent::__construct($name, $mode);

        $this->setContentGenerator($contents);

It seems like $contents defined by parameter $contents on line 33 can also be of type string; however, Naneau\FileGen\File::setContentGenerator() does only seem to accept object<Naneau\FileGen\File\Contents>, maybe add an additional type check?

    }

    /**
     * Get the contents as a string
     *
     * @param  array[string]string $parameters

The doc-type array[string]string could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

     * @return string
     **/
    public function getContents(array $parameters = array())
    {
        // Merge incoming parameters with that of the content generator if the
        // content generator is parameterized
        if ($this->getContentGenerator() instanceof Parameterized) {
            $this->getContentGenerator()->setParameters(array_merge(
                $this->getContentGenerator()->getParameters(),
                $parameters
            ));
        }

        return $this->getContentGenerator()->getContents();
    }

    /**
     * Get the content generator
     *
     * @return ContentGenerator
     */
    public function getContentGenerator()
    {
        return $this->contentGenerator;
    }

    /**
     * Set the content generator
     *
     * @param  ContentGenerator $contentGenerator
     * @return File
     */
    public function setContentGenerator($contentGenerator)
    {
        if (is_string($contentGenerator)) {
            $this->contentGenerator = new StringContents($contentGenerator);
        } elseif ($contentGenerator instanceof ContentGenerator) {
            $this->contentGenerator = $contentGenerator;
        } else {
            throw new InvalidArgumentException(
                'Content generator needs to be string or instance of Naneau\FileGen\File\Contents'
            );
        }

        return $this;
    }
}