Completed
Push — master ( 227e03...1b465c )
by Artem
10:47 queued 05:43
created

configureSettings()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nc 1
nop 1
dl 0
loc 6
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace Application\Bundle\DefaultBundle\Service\EventBlock;
4
5
use Doctrine\Common\Persistence\ObjectRepository;
6
use Sonata\BlockBundle\Block\BlockContextInterface;
7
use Sonata\BlockBundle\Block\Service\AbstractBlockService;
8
use Stfalcon\Bundle\EventBundle\Entity\Event;
9
use Stfalcon\Bundle\EventBundle\Repository\ReviewRepository;
10
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
11
use Symfony\Component\HttpFoundation\Response;
12
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
13
use Symfony\Component\OptionsResolver\OptionsResolver;
14
use Symfony\Component\Translation\IdentityTranslator;
15
use Symfony\Component\Translation\TranslatorInterface;
16
17
/**
18
 * Class CandidateSpeakersEventBlockService.
19
 */
20
class CandidateSpeakersEventBlockService extends AbstractBlockService
21
{
22
    /** @var IdentityTranslator */
23
    private $translator;
24
25
    /** @var ReviewRepository */
26
    private $reviewRepository;
27
28
    /**
29
     * SpeakersEventBlockService constructor.
30
     *
31
     * @param string              $name
32
     * @param EngineInterface     $templating
33
     * @param TranslatorInterface $translator
34
     * @param ObjectRepository    $reviewRepository
35
     */
36
    public function __construct($name, EngineInterface $templating, TranslatorInterface $translator, ObjectRepository $reviewRepository)
37
    {
38
        parent::__construct($name, $templating);
39
40
        $this->translator = $translator;
0 ignored issues
show
Documentation Bug introduced by
$translator is of type Symfony\Component\Translation\TranslatorInterface, but the property $translator was declared to be of type Symfony\Component\Translation\IdentityTranslator. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.

Either this assignment is in error or an instanceof check should be added for that assignment.

class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
Loading history...
41
        $this->reviewRepository = $reviewRepository;
0 ignored issues
show
Documentation Bug introduced by
$reviewRepository is of type Doctrine\Common\Persistence\ObjectRepository, but the property $reviewRepository was declared to be of type Stfalcon\Bundle\EventBun...sitory\ReviewRepository. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.

Either this assignment is in error or an instanceof check should be added for that assignment.

class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
Loading history...
42
    }
43
44
    /**
45
     * {@inheritdoc}
46
     */
47
    public function execute(BlockContextInterface $blockContext, Response $response = null)
48
    {
49
        $event = $blockContext->getSetting('event');
50
51
        if (!$event instanceof Event) {
52
            return new NotFoundHttpException();
0 ignored issues
show
Bug Best Practice introduced by
The expression return new Symfony\Compo...NotFoundHttpException() returns the type Symfony\Component\HttpKe...n\NotFoundHttpException which is incompatible with the return type mandated by Sonata\BlockBundle\Block...iceInterface::execute() of Symfony\Component\HttpFoundation\Response.

In the issue above, the returned value is violating the contract defined by the mentioned interface.

Let's take a look at an example:

interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
Loading history...
53
        }
54
55
        $speakers = $event->getCandidateSpeakers();
56
57
        /** @var $speaker \Stfalcon\Bundle\EventBundle\Entity\Speaker */
58
        foreach ($speakers as &$speaker) {
59
            $speaker->setReviews(
60
                $this->reviewRepository->findReviewsOfSpeakerForEvent($speaker, $event)
61
            );
62
        }
63
64
        return $this->renderResponse($blockContext->getTemplate(), [
65
            'block' => $blockContext->getBlock(),
66
            'templateTitle' => $this->translator->trans('candidate.speaker.title'),
67
            'speakers' => $speakers,
68
            'section_id' => 'candidate-speakers-event',
69
            'with_review' => true,
70
            'event' => $event,
71
        ], $response);
72
    }
73
74
    /**
75
     * {@inheritdoc}
76
     */
77
    public function configureSettings(OptionsResolver $resolver)
78
    {
79
        $resolver->setDefaults([
80
            'template' => 'ApplicationDefaultBundle:Redesign/Event:event.speakers.html.twig',
81
            'event' => null,
82
            'event_block' => null,
83
        ]);
84
    }
85
}
86