AbstractGenerator::runGenerate() - Code Metrics - Inspection of "Work on generators" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — collection-and-generator ( 3521a6 )

by Arnaud

created 2019-03-18 16:24 UTC

AbstractGenerator::runGenerate() A

↳ Parent: AbstractGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
c	0
b	0
f	0
rs	9.9666
cc	1
nc	1
nop	2

<?php
/*
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Generator;

use Cecil\Collection\Page\Collection as PagesCollection;
use Cecil\Config;
use Cecil\Util;

/**
 * Abstract class AbstractGenerator.
 */
abstract class AbstractGenerator implements GeneratorInterface
{
    /* @var Config */
    protected $config;
    /* @var PagesCollection */
    protected $pagesCollection;
    /* @var $messageCallback */
    protected $messageCallback;
    /* @var PagesCollection */
    protected $generatedPages;

    /**
     * {@inheritdoc}
     */
    public function __construct(Config $config)
    {
        $this->config = $config;
        // Create new empty collection
        //$this->generatedPages = new PagesCollection('generator-'.$this->getGeneratorName($this));
        $this->generatedPages = new PagesCollection('generator-'.Util::formatClassName($this));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param PagesCollection $pagesCollection
     * @param \Closure        $messageCallback
     *
     * @return PagesCollection
     */
    public function runGenerate(PagesCollection $pagesCollection, \Closure $messageCallback): PagesCollection
    {
        $this->pagesCollection = $pagesCollection;
        $this->messageCallback = $messageCallback;

        $this->generate();

        return $this->generatedPages;
    }

    /**
     * Format generator name.
     *
     * @param self $class

     *
     * @return string
     */
    protected static function getGeneratorName(self $class): string
    {
        return strtolower(substr(strrchr(get_class($class), '\\'), 1));
    }
}


1			<?php
2			/*
3			* Copyright (c) Arnaud Ligny <[email protected]>
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8
9			namespace Cecil\Generator;
10
11			use Cecil\Collection\Page\Collection as PagesCollection;
12			use Cecil\Config;
13			use Cecil\Util;
14
15			/**
16			* Abstract class AbstractGenerator.
17			*/
18			abstract class AbstractGenerator implements GeneratorInterface
19			{
20			/* @var Config */
21			protected $config;
22			/* @var PagesCollection */
23			protected $pagesCollection;
24			/* @var $messageCallback */
25			protected $messageCallback;
26			/* @var PagesCollection */
27			protected $generatedPages;
28
29			/**
30			* {@inheritdoc}
31			*/
32			public function __construct(Config $config)
33			{
34			$this->config = $config;
35			// Create new empty collection
36			//$this->generatedPages = new PagesCollection('generator-'.$this->getGeneratorName($this));
37			$this->generatedPages = new PagesCollection('generator-'.Util::formatClassName($this));
			0 ignored issues – show Documentation introduced 2019-03-18 16:27 UTC by Report Bug Copy Issue Report `$this` is of type `this<Cecil\Generator\AbstractGenerator>`, but the function expects a `object<object>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
38			}
39
40			/**
41			* @param PagesCollection $pagesCollection
42			* @param \Closure $messageCallback
43			*
44			* @return PagesCollection
45			*/
46			public function runGenerate(PagesCollection $pagesCollection, \Closure $messageCallback): PagesCollection
47			{
48			$this->pagesCollection = $pagesCollection;
49			$this->messageCallback = $messageCallback;
50
51			$this->generate();
52
53			return $this->generatedPages;
54			}
55
56			/**
57			* Format generator name.
58			*
59			* @param self $class
			0 ignored issues – show Documentation introduced 2019-03-18 16:27 UTC by Report Bug Copy Issue Report Should the type for parameter `$class` not be `\self`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
60			*
61			* @return string
62			*/
63			protected static function getGeneratorName(self $class): string
64			{
65			return strtolower(substr(strrchr(get_class($class), '\\'), 1));
66			}
67			}
68

Cecilapp / Cecil

Push — collection-and-generator ( 3521a6 )

AbstractGenerator::runGenerate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like