ContentListService::__construct() - Code Metrics - Inspection of "Add sortable to content items, LINK/UNLINK content..." - ahilles107/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 692aa1...25e5a7 )

by Paweł

created 2017-03-16 13:53 UTC

ContentListService::__construct() A

↳ Parent: ContentListService

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Web Publisher Content List Bundle.
 *
 * Copyright 2016 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2016 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\ContentListBundle\Services;

use SWP\Bundle\ContentBundle\Model\ArticleInterface;
use SWP\Bundle\ContentListBundle\Event\ContentListEvent;
use SWP\Component\ContentList\ContentListEvents;
use SWP\Component\ContentList\Model\ContentListInterface;
use SWP\Component\ContentList\Model\ContentListItemInterface;
use SWP\Component\ContentList\Model\ListContentInterface;
use SWP\Component\Storage\Factory\FactoryInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

final class ContentListService implements ContentListServiceInterface
{
    /**
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * @var FactoryInterface
     */
    protected $listItemFactory;

    /**
     * ContentListService constructor.
     *
     * @param EventDispatcherInterface $eventDispatcher
     * @param FactoryInterface         $listItemFactory
     */
    public function __construct(EventDispatcherInterface $eventDispatcher, FactoryInterface $listItemFactory)
    {
        $this->eventDispatcher = $eventDispatcher;
        $this->listItemFactory = $listItemFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function addArticleToContentList(ContentListInterface $contentList, ArticleInterface $article, $position = null)
    {
        /* @var ContentListItemInterface $contentListItem */
        $contentListItem = $this->listItemFactory->create();

        if ($article instanceof ListContentInterface) {
            $contentListItem->setContent($article);
        }

        if (null === $position) {
            $position = $contentList->getItems()->count();
        }

        $contentListItem->setPosition((int) $position);
        $contentList->addItem($contentListItem);
        $this->eventDispatcher->dispatch(
            ContentListEvents::POST_ITEM_ADD,
            new ContentListEvent($contentList, $contentListItem)
        );

        return $contentListItem;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Superdesk Web Publisher Content List Bundle.
7			*
8			* Copyright 2016 Sourcefabric z.ú. and contributors.
9			*
10			* For the full copyright and license information, please see the
11			* AUTHORS and LICENSE files distributed with this source code.
12			*
13			* @copyright 2016 Sourcefabric z.ú
14			* @license http://www.superdesk.org/license
15			*/
16
17			namespace SWP\Bundle\ContentListBundle\Services;
18
19			use SWP\Bundle\ContentBundle\Model\ArticleInterface;
20			use SWP\Bundle\ContentListBundle\Event\ContentListEvent;
21			use SWP\Component\ContentList\ContentListEvents;
22			use SWP\Component\ContentList\Model\ContentListInterface;
23			use SWP\Component\ContentList\Model\ContentListItemInterface;
24			use SWP\Component\ContentList\Model\ListContentInterface;
25			use SWP\Component\Storage\Factory\FactoryInterface;
26			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
27
28			final class ContentListService implements ContentListServiceInterface
29			{
30			/**
31			* @var EventDispatcherInterface
32			*/
33			protected $eventDispatcher;
34
35			/**
36			* @var FactoryInterface
37			*/
38			protected $listItemFactory;
39
40			/**
41			* ContentListService constructor.
42			*
43			* @param EventDispatcherInterface $eventDispatcher
44			* @param FactoryInterface $listItemFactory
45			*/
46			public function __construct(EventDispatcherInterface $eventDispatcher, FactoryInterface $listItemFactory)
47			{
48			$this->eventDispatcher = $eventDispatcher;
49			$this->listItemFactory = $listItemFactory;
50			}
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function addArticleToContentList(ContentListInterface $contentList, ArticleInterface $article, $position = null)
56			{
57			/* @var ContentListItemInterface $contentListItem */
58			$contentListItem = $this->listItemFactory->create();
59
60			if ($article instanceof ListContentInterface) {
61			$contentListItem->setContent($article);
62			}
63
64			if (null === $position) {
65			$position = $contentList->getItems()->count();
66			}
67
68			$contentListItem->setPosition((int) $position);
69			$contentList->addItem($contentListItem);
70			$this->eventDispatcher->dispatch(
71			ContentListEvents::POST_ITEM_ADD,
72			new ContentListEvent($contentList, $contentListItem)
73			);
74
75			return $contentListItem;
			0 ignored issues – show Bug Best Practice introduced 2017-03-16 14:53 UTC by Report Bug Copy Issue Report The return type of `return $contentListItem;` (`SWP\Component\ContentLis...ontentListItemInterface`) is incompatible with the return type declared by the interface `SWP\Bundle\ContentListBu...addArticleToContentList` of type `SWP\Bundle\ContentListBu...ontentListItemInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
76			}
77			}
78

ahilles107 / web-publisher

Push — master ( 692aa1...25e5a7 )

ContentListService::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like