TocProcess::__construct() - Code Metrics - bookdown/Bookdown.Bookdown - Measure and Improve Code Quality continuously with Scrutinizer

TocProcess::__construct() A
last analyzed 2016-03-04 17:46 UTC

↳ Parent: TocProcess

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

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

<?php
namespace Bookdown\Bookdown\Process\Toc;

use Psr\Log\LoggerInterface;
use Bookdown\Bookdown\Content\Page;
use Bookdown\Bookdown\Content\IndexPage;
use Bookdown\Bookdown\Process\ProcessInterface;

class TocProcess implements ProcessInterface
{
    protected $logger;
    protected $tocEntries;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function __invoke(Page $page)
    {
        if (! $page->isIndex()) {
            $this->logger->info("    Skipping TOC entries for non-index {$page->getTarget()}");
            return;
        }

        $this->logger->info("    Adding TOC entries for {$page->getTarget()}");
        $this->tocEntries = array();
        // if there are multiple books, ensure correct toc level
        $this->addTocEntries($page, $page->getConfig()->getTocDepth(), $page->isRoot() ? 0 : 1);
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.
    }
}
        $page->setTocEntries($this->tocEntries);
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.
    }
}
    }

    /**
     * A toc depth of 0 means render all headings. A toc depth of 1 is a special case
     *
     * @param IndexPage $index
     * @param $tocDepth
     * @param int $level
     */
    protected function addTocEntries(IndexPage $index, $tocDepth, $level = 0)
    {
        $maxLevel = $level + $tocDepth;

        if ($tocDepth !== 1 && $tocDepth && $index->isRoot()) {
            $maxLevel --;
        }

        foreach ($index->getChildren() as $child) {
            $headings = $child->getHeadings();
            foreach ($headings as $heading) {
                if ($tocDepth && $heading->getLevel() > $maxLevel) {
                    continue;
                }
                $this->tocEntries[] = $heading;
            }
            if ($child->isIndex() && $tocDepth !== 1) {
                $this->addTocEntries($child, $tocDepth, $index->isRoot() ? $level : ($level + 1));

            }
        }
    }
}


TocProcess::__construct() A
last analyzed 2016-03-04 17:46 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2		namespace Bookdown\Bookdown\Process\Toc;
3
4		use Psr\Log\LoggerInterface;
5		use Bookdown\Bookdown\Content\Page;
6		use Bookdown\Bookdown\Content\IndexPage;
7		use Bookdown\Bookdown\Process\ProcessInterface;
8
9		class TocProcess implements ProcessInterface
10		{
11		protected $logger;
12		protected $tocEntries;
13
14	12	public function __construct(LoggerInterface $logger)
15		{
16	12	$this->logger = $logger;
17	12	}
18
19	11	public function __invoke(Page $page)
20		{
21	11	if (! $page->isIndex()) {
22	3	$this->logger->info(" Skipping TOC entries for non-index {$page->getTarget()}");
23	3	return;
24		}
25
26	10	$this->logger->info(" Adding TOC entries for {$page->getTarget()}");
27	10	$this->tocEntries = array();
28		// if there are multiple books, ensure correct toc level
29	10	$this->addTocEntries($page, $page->getConfig()->getTocDepth(), $page->isRoot() ? 0 : 1);
		0 ignored issues – show Bug introduced 2016-03-04 17:46 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Bookdown\Bookdown\Content\Page` as the method `getConfig()` does only exist in the following sub-classes of `Bookdown\Bookdown\Content\Page`: `Bookdown\Bookdown\Content\IndexPage`, `Bookdown\Bookdown\Content\RootPage`. 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... Compatibility introduced 2016-03-04 17:46 UTC by Report Bug Copy Issue Report `$page` of type `object<Bookdown\Bookdown\Content\Page>` is not a sub-type of `object<Bookdown\Bookdown\Content\IndexPage>`. It seems like you assume a child class of the class `Bookdown\Bookdown\Content\Page` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
30	10	$page->setTocEntries($this->tocEntries);
		0 ignored issues – show Bug introduced 2016-02-18 09:58 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Bookdown\Bookdown\Content\Page` as the method `setTocEntries()` does only exist in the following sub-classes of `Bookdown\Bookdown\Content\Page`: `Bookdown\Bookdown\Content\IndexPage`, `Bookdown\Bookdown\Content\RootPage`. 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...
31	10	}
32
33		/**
34		* A toc depth of 0 means render all headings. A toc depth of 1 is a special case
35		*
36		* @param IndexPage $index
37		* @param $tocDepth
38		* @param int $level
39		*/
40	10	protected function addTocEntries(IndexPage $index, $tocDepth, $level = 0)
41		{
42	10	$maxLevel = $level + $tocDepth;
43
44	10	if ($tocDepth !== 1 && $tocDepth && $index->isRoot()) {
45	2	$maxLevel --;
46	2	}
47
48	10	foreach ($index->getChildren() as $child) {
49	10	$headings = $child->getHeadings();
50	10	foreach ($headings as $heading) {
51	10	if ($tocDepth && $heading->getLevel() > $maxLevel) {
52	5	continue;
53		}
54	10	$this->tocEntries[] = $heading;
55	10	}
56	10	if ($child->isIndex() && $tocDepth !== 1) {
57	5	$this->addTocEntries($child, $tocDepth, $index->isRoot() ? $level : ($level + 1));
		0 ignored issues – show Compatibility introduced 2016-03-04 17:46 UTC by Report Bug Copy Issue Report `$child` of type `object<Bookdown\Bookdown\Content\Page>` is not a sub-type of `object<Bookdown\Bookdown\Content\IndexPage>`. It seems like you assume a child class of the class `Bookdown\Bookdown\Content\Page` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
58	5	}
59	10	}
60	10	}
61		}
62

bookdown / Bookdown.Bookdown

TocProcess::__construct() A last analyzed 2016-03-04 17:46 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

TocProcess::__construct() A
last analyzed 2016-03-04 17:46 UTC