Completed
Push — include-lib ( fd24a6...4173d3 )
by Arnaud
13:24
created

PagesFromConfig   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 27
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 4

Importance

Changes 0
Metric Value
wmc 4
lcom 1
cbo 4
dl 0
loc 27
rs 10
c 0
b 0
f 0

1 Method

Rating   Name   Duplication   Size   Complexity  
A generate() 0 21 4
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\Collection as PageCollection;
12
use Cecil\Collection\Page\Page;
13
14
/**
15
 * Class PagesFromConfig.
16
 */
17
class PagesFromConfig extends AbstractGenerator implements GeneratorInterface
18
{
19
    /**
20
     * {@inheritdoc}
21
     */
22
    public function generate(PageCollection $pageCollection, \Closure $messageCallback)
23
    {
24
        $generatedPages = new PageCollection();
25
26
        $fmPages = $this->config->get('site.fmpages');
27
        foreach ($fmPages as $file => $frontmatter) {
28
            $page = (new Page())
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
29
                ->setId(Page::urlize(sprintf('%s', $file)))
30
                ->setPathname(Page::urlize(sprintf('%s', $file)));
31
            $page->setVariables($frontmatter);
32
            if (!empty($frontmatter['layout'])) {
33
                $page->setLayout($frontmatter['layout']);
34
            }
35
            if (!empty($frontmatter['permalink'])) {
36
                $page->setPermalink($frontmatter['permalink']);
37
            }
38
            $generatedPages->add($page);
39
        }
40
41
        return $generatedPages;
42
    }
43
}
44