VirtualPages::generate() - Code Metrics - Inspection of "WIP" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature-output-formats ( 7414b6...a25fbf )

by Arnaud

created 2019-01-25 16:52 UTC

VirtualPages::generate() A

↳ Parent: VirtualPages

Complexity

Conditions	5
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	26
rs	9.1928
c	0
b	0
f	0
cc	5
nc	6
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\Collection\Page\Page;
use Cecil\Page\Type;

/**
 * Class VirtualPages.
 */
class VirtualPages extends AbstractGenerator implements GeneratorInterface
{
    /**
     * {@inheritdoc}
     */
    public function generate(PagesCollection $pagesCollection, \Closure $messageCallback)
    {
        $generatedPages = new PagesCollection();

        $virtualpages = $this->config->get('site.virtualpages');
        foreach ($virtualpages as $file => $frontmatter) {
            if ($frontmatter == 'disabled') {
                continue;
            }
            $pageId = Page::urlize(sprintf('%s', $file));
            $page = (new Page())
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ->setId($pageId)
                ->setPathname($pageId)
                ->setType(Type::PAGE);
            $page->setVariables($frontmatter);
            if (!empty($frontmatter['layout'])) {
                $page->setLayout($frontmatter['layout']);
            }
            if (!empty($frontmatter['permalink'])) {
                $page->setPermalink($frontmatter['permalink']);
            }
            $generatedPages->add($page);
        }

        return $generatedPages;
    }
}


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\Collection\Page\Page;
13			use Cecil\Page\Type;
14
15			/**
16			* Class VirtualPages.
17			*/
18			class VirtualPages extends AbstractGenerator implements GeneratorInterface
19			{
20			/**
21			* {@inheritdoc}
22			*/
23			public function generate(PagesCollection $pagesCollection, \Closure $messageCallback)
24			{
25			$generatedPages = new PagesCollection();
26
27			$virtualpages = $this->config->get('site.virtualpages');
28			foreach ($virtualpages as $file => $frontmatter) {
29			if ($frontmatter == 'disabled') {
30			continue;
31			}
32			$pageId = Page::urlize(sprintf('%s', $file));
33			$page = (new Page())
			0 ignored issues – show Bug introduced 2019-01-11 15:43 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Cecil\Collection\Item` as the method `setPathname()` does only exist in the following sub-classes of `Cecil\Collection\Item`: `Cecil\Collection\Page\Page`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
34			->setId($pageId)
35			->setPathname($pageId)
36			->setType(Type::PAGE);
37			$page->setVariables($frontmatter);
38			if (!empty($frontmatter['layout'])) {
39			$page->setLayout($frontmatter['layout']);
40			}
41			if (!empty($frontmatter['permalink'])) {
42			$page->setPermalink($frontmatter['permalink']);
43			}
44			$generatedPages->add($page);
45			}
46
47			return $generatedPages;
48			}
49			}
50

Cecilapp / Cecil

Push — feature-output-formats ( 7414b6...a25fbf )

VirtualPages::generate() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like