File::getContentGenerator() - Code Metrics - naneau/filegen - Measure and Improve Code Quality continuously with Scrutinizer

File::getContentGenerator() A
last analyzed 2017-07-04 14:02 UTC

↳ Parent: File

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?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

     **/
    public function __construct($name, $contents = '', $mode = null)
    {
        parent::__construct($name, $mode);

        $this->setContentGenerator($contents);

    }

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

     * @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;
    }
}


1			<?php
2			namespace Naneau\FileGen;
3
4			use Naneau\FileGen\Parameterized;
5
6			use Naneau\FileGen\AccessRights;
7
8			use Naneau\FileGen\File\Contents as ContentGenerator;
9			use Naneau\FileGen\File\Contents\StringBased as StringContents;
10
11			use \InvalidArgumentException;
12
13			/**
14			* A file
15			*/
16			class File extends AccessRights
17			{
18			/**
19			* Contents of the file
20			*
21			* @var ContentGenerator
22			**/
23			private $contentGenerator;
24
25			/**
26			* Constructor
27			*
28			* @param string $name
29			* @param ContentGenerator\|string $contents
30			* @param int $mode mode in octal 0XXX
31			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-02-09 14:23 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
32			**/
33			public function __construct($name, $contents = '', $mode = null)
34			{
35			parent::__construct($name, $mode);
36
37			$this->setContentGenerator($contents);
			0 ignored issues – show Bug introduced 2017-02-09 14:23 UTC by Report Bug Copy Issue Report 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? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
38			}
39
40			/**
41			* Get the contents as a string
42			*
43			* @param array[string]string $parameters
			0 ignored issues – show Documentation introduced 2017-02-09 14:23 UTC by Report Bug Copy Issue Report The doc-type `array[string]string` could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
44			* @return string
45			**/
46			public function getContents(array $parameters = array())
47			{
48			// Merge incoming parameters with that of the content generator if the
49			// content generator is parameterized
50			if ($this->getContentGenerator() instanceof Parameterized) {
51			$this->getContentGenerator()->setParameters(array_merge(
52			$this->getContentGenerator()->getParameters(),
53			$parameters
54			));
55			}
56
57			return $this->getContentGenerator()->getContents();
58			}
59
60			/**
61			* Get the content generator
62			*
63			* @return ContentGenerator
64			*/
65			public function getContentGenerator()
66			{
67			return $this->contentGenerator;
68			}
69
70			/**
71			* Set the content generator
72			*
73			* @param ContentGenerator $contentGenerator
74			* @return File
75			*/
76			public function setContentGenerator($contentGenerator)
77			{
78			if (is_string($contentGenerator)) {
79			$this->contentGenerator = new StringContents($contentGenerator);
80			} elseif ($contentGenerator instanceof ContentGenerator) {
81			$this->contentGenerator = $contentGenerator;
82			} else {
83			throw new InvalidArgumentException(
84			'Content generator needs to be string or instance of Naneau\FileGen\File\Contents'
85			);
86			}
87
88			return $this;
89			}
90			}
91

naneau / filegen

GitHub Access Token became invalid

File::getContentGenerator() A last analyzed 2017-07-04 14:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

File::getContentGenerator() A
last analyzed 2017-07-04 14:02 UTC