SendMessageAction::doExecute() - Code Metrics - thephplab/lightsaml - Measure and Improve Code Quality continuously with Scrutinizer

SendMessageAction::doExecute() A
last analyzed 2020-07-28 16:14 UTC

↳ Parent: SendMessageAction

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	17
c	0
b	0
f	0
ccs	10
cts	10
cp	1
rs	9.7
cc	1
nc	1
nop	1
crap	1

<?php

/*
 * This file is part of the LightSAML-Core package.
 *
 * (c) Milos Tomic <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace LightSaml\Action\Profile\Outbound\Message;

use LightSaml\Action\Profile\AbstractProfileAction;
use LightSaml\Binding\BindingFactoryInterface;
use LightSaml\Context\Profile\Helper\LogHelper;
use LightSaml\Context\Profile\ProfileContext;
use Psr\Log\LoggerInterface;

class SendMessageAction extends AbstractProfileAction
{
    /** @var BindingFactoryInterface */
    protected $bindingFactory;

    /**
     * @param LoggerInterface         $logger
     * @param BindingFactoryInterface $bindingFactory
     */
    public function __construct(LoggerInterface $logger, BindingFactoryInterface $bindingFactory)
    {
        parent::__construct($logger);

        $this->bindingFactory = $bindingFactory;
    }

    /**
     * @param ProfileContext $context
     *
     * @return void
     */
    public function doExecute(ProfileContext $context)
    {
        $binding = $this->bindingFactory->create($context->getEndpoint()->getBinding());

        $outboundContext = $context->getOutboundContext();

        $context->getHttpResponseContext()->setResponse(
            $binding->send($outboundContext)
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        );

        $this->logger->info(
            'Sending message',
            LogHelper::getActionContext($context, $this, array(
                'message' => $outboundContext->getSerializationContext()->getDocument()->saveXML(),
            ))
        );
    }
}


1		<?php
2
3		/*
4		* This file is part of the LightSAML-Core package.
5		*
6		* (c) Milos Tomic <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace LightSaml\Action\Profile\Outbound\Message;
13
14		use LightSaml\Action\Profile\AbstractProfileAction;
15		use LightSaml\Binding\BindingFactoryInterface;
16		use LightSaml\Context\Profile\Helper\LogHelper;
17		use LightSaml\Context\Profile\ProfileContext;
18		use Psr\Log\LoggerInterface;
19
20		class SendMessageAction extends AbstractProfileAction
21		{
22		/** @var BindingFactoryInterface */
23		protected $bindingFactory;
24
25		/**
26		* @param LoggerInterface $logger
27		* @param BindingFactoryInterface $bindingFactory
28		*/
29	3	public function __construct(LoggerInterface $logger, BindingFactoryInterface $bindingFactory)
30		{
31	3	parent::__construct($logger);
32
33	3	$this->bindingFactory = $bindingFactory;
34	3	}
35
36		/**
37		* @param ProfileContext $context
38		*
39		* @return void
40		*/
41	2	public function doExecute(ProfileContext $context)
42		{
43	2	$binding = $this->bindingFactory->create($context->getEndpoint()->getBinding());
44
45	2	$outboundContext = $context->getOutboundContext();
46
47	2	$context->getHttpResponseContext()->setResponse(
48	2	$binding->send($outboundContext)
		0 ignored issues – show Bug introduced 2020-07-28 16:14 UTC by Report Bug Copy Issue Report It seems like `$outboundContext` defined by `$context->getOutboundContext()` on line `45` can be `null`; however, `LightSaml\Binding\AbstractBinding::send()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
49		);
50
51	2	$this->logger->info(
52	2	'Sending message',
53	2	LogHelper::getActionContext($context, $this, array(
54	2	'message' => $outboundContext->getSerializationContext()->getDocument()->saveXML(),
55		))
56		);
57	2	}
58		}
59

thephplab / lightsaml

SendMessageAction::doExecute() A last analyzed 2020-07-28 16:14 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SendMessageAction::doExecute() A
last analyzed 2020-07-28 16:14 UTC