Alias::getPageAliases() - Code Metrics - Inspection of "Add Collection sortByWeight" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature-output-formats ( 361247...47e05f )

by Arnaud

created 2019-02-18 17:21 UTC

Alias::getPageAliases() A

↳ Parent: Alias

Complexity

Conditions	4
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	4
nc	8
nop	1

<?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;

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

        /* @var $page Page */
        foreach ($pagesCollection as $page) {
            $aliases = $this->getPageAliases($page);

            if (!empty($aliases)) {
                foreach ($aliases as $alias) {
                    /* @var $aliasPage Page */
                    $pageId = $path = Page::slugify($alias);
                    $aliasPage = (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)
                        ->setPath($path)
                        ->setVariables([
                            'layout'   => 'redirect',
                            'redirect' => $page->getPath(),
                            'title'    => $alias,
                            'date'     => $page->getVariable('date'),
                        ]);
                    $generatedPages->add($aliasPage);
                }
            }
        }

        return $generatedPages;
    }

    /**
     * Return aliases array.
     *
     * @param Page $page
     *
     * @return array
     */
    protected function getPageAliases(Page $page): array
    {
        $aliases = [];

        if ($page->hasVariable('aliases')) { // backward compatibility
            $aliases = $page->getVariable('aliases');
        }
        if ($page->hasVariable('alias')) {
            $aliases = $page->getVariable('alias');
        }
        if (!is_array($aliases)) {
            $aliases = [$aliases];
        }

        return $aliases;
    }
}


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
14			/**
15			* Class Alias.
16			*/
17			class Alias extends AbstractGenerator implements GeneratorInterface
18			{
19			/**
20			* {@inheritdoc}
21			*/
22			public function generate(PagesCollection $pagesCollection, \Closure $messageCallback)
23			{
24			$generatedPages = new PagesCollection();
25
26			/* @var $page Page */
27			foreach ($pagesCollection as $page) {
28			$aliases = $this->getPageAliases($page);
29
30			if (!empty($aliases)) {
31			foreach ($aliases as $alias) {
32			/* @var $aliasPage Page */
33			$pageId = $path = Page::slugify($alias);
34			$aliasPage = (new Page())
			0 ignored issues – show Bug introduced 2019-02-18 17:23 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 `setPath()` 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...
35			->setId($pageId)
36			->setPath($path)
37			->setVariables([
38			'layout' => 'redirect',
39			'redirect' => $page->getPath(),
40			'title' => $alias,
41			'date' => $page->getVariable('date'),
42			]);
43			$generatedPages->add($aliasPage);
44			}
45			}
46			}
47
48			return $generatedPages;
49			}
50
51			/**
52			* Return aliases array.
53			*
54			* @param Page $page
55			*
56			* @return array
57			*/
58			protected function getPageAliases(Page $page): array
59			{
60			$aliases = [];
61
62			if ($page->hasVariable('aliases')) { // backward compatibility
63			$aliases = $page->getVariable('aliases');
64			}
65			if ($page->hasVariable('alias')) {
66			$aliases = $page->getVariable('alias');
67			}
68			if (!is_array($aliases)) {
69			$aliases = [$aliases];
70			}
71
72			return $aliases;
73			}
74			}
75

Cecilapp / Cecil

Push — feature-output-formats ( 361247...47e05f )

Alias::getPageAliases() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like