AbstractGenerator::__construct() - Code Metrics - Inspection of "8.x dev" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1676)

by Arnaud

created 2023-12-05 00:25 UTC

AbstractGenerator::__construct() A

↳ Parent: AbstractGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	6
ccs	4
cts	4
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * 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\Builder;
use Cecil\Collection\Page\Collection as PagesCollection;
use Cecil\Util;

/**
 * Abstract class AbstractGenerator.
 */
abstract class AbstractGenerator implements GeneratorInterface
{
    /** @var Builder */
    protected $builder;

    /** @var \Cecil\Config */
    protected $config;

    /** @var PagesCollection */
    protected $generatedPages;

    /**
     * {@inheritdoc}
     */
    public function __construct(Builder $builder)
    {
        $this->builder = $builder;
        $this->config = $builder->getConfig();
        // Creates a new empty collection
        $this->generatedPages = new PagesCollection('generator-' . Util::formatClassName($this, ['lowercase' => true]));
    }

    /**
     * Run the `generate` method of the generator and returns pages.
     */
    public function runGenerate(): PagesCollection
    {
        $this->generate();

        // set default language (e.g.: "en") if necessary
        $this->generatedPages->map(function (\Cecil\Collection\Page\Page $page) {
            if ($page->getVariable('language') === null) {
                $page->setVariable('language', $this->config->getLanguageDefault());
            }
        });

        return $this->generatedPages;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of Cecil.
7		*
8		* Copyright (c) Arnaud Ligny <[email protected]>
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Cecil\Generator;
15
16		use Cecil\Builder;
17		use Cecil\Collection\Page\Collection as PagesCollection;
18		use Cecil\Util;
19
20		/**
21		* Abstract class AbstractGenerator.
22		*/
23		abstract class AbstractGenerator implements GeneratorInterface
24		{
25		/** @var Builder */
26		protected $builder;
27
28		/** @var \Cecil\Config */
29		protected $config;
30
31		/** @var PagesCollection */
32		protected $generatedPages;
33
34		/**
35		* {@inheritdoc}
36		*/
37	1	public function __construct(Builder $builder)
38		{
39	1	$this->builder = $builder;
40	1	$this->config = $builder->getConfig();
41		// Creates a new empty collection
42	1	$this->generatedPages = new PagesCollection('generator-' . Util::formatClassName($this, ['lowercase' => true]));
43		}
44
45		/**
46		* Run the `generate` method of the generator and returns pages.
47		*/
48	1	public function runGenerate(): PagesCollection
49		{
50	1	$this->generate();
51
52		// set default language (e.g.: "en") if necessary
53	1	$this->generatedPages->map(function (\Cecil\Collection\Page\Page $page) {
54	1	if ($page->getVariable('language') === null) {
55	1	$page->setVariable('language', $this->config->getLanguageDefault());
56		}
57	1	});
58
59	1	return $this->generatedPages;
60		}
61		}
62

Cecilapp / Cecil

Pull Request — master (#1676)

AbstractGenerator::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like