AuthenticationHandlerEvent::getResponse() - Code Metrics - ldaptools/ldaptools-bundle - Measure and Improve Code Quality continuously with Scrutinizer

AuthenticationHandlerEvent::getResponse() A
last analyzed 2018-06-07 22:03 UTC

↳ Parent: AuthenticationHandlerEvent

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
rs	10
c	1
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * This file is part of the LdapToolsBundle package.
 *
 * (c) Chad Sikorra <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace LdapTools\Bundle\LdapToolsBundle\Event;

use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;

/**
 * Represents an authentication handler event, such as success or failure, where the response can be set.
 *
 * @author Chad Sikorra <[email protected]>
 */
class AuthenticationHandlerEvent extends Event
{
    /**
     * The event name that happens after the default authentication success handler is called.
     */
    const SUCCESS = 'ldap_tools_bundle.guard.login.success';

    /**
     * The event name that happens after the default authentication failure handler is called.
     */
    const FAILURE = 'ldap_tools_bundle.guard.login.failure';

    /**
     * The event name that happens when the entry point is called for the guard and returns a redirect/response.
     */
    const START = 'ldap_tools_bundle.guard.login.start';

    /**
     * @var Response
     */
    protected $response;

    /**
     * @var AuthenticationException|null
     */
    protected $exception;

    /**
     * @var Request
     */
    protected $request;

    /**
     * @var TokenInterface|null
     */
    protected $token;

    /**
     * @var string|null
     */
    protected $providerKey;

    /**
     * @param Response $response
     * @param Request $request
     * @param null|AuthenticationException $exception
     * @param TokenInterface|null $token
     * @param string|null $providerKey
     */
    public function __construct(Response $response, Request $request, AuthenticationException $exception = null, TokenInterface $token = null, $providerKey = null)

    {
        $this->request = $request;
        $this->response = $response;
        $this->exception = $exception;
        $this->token = $token;
        $this->providerKey = $providerKey;
    }

    /**
     * @return Response
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * @param Response $response
     * @return $this
     */
    public function setResponse(Response $response)
    {
        $this->response = $response;

        return $this;
    }

    /**
     * @return AuthenticationException|null
     */
    public function getException()
    {
        return $this->exception;
    }

    /**
     * @return null|TokenInterface
     */
    public function getToken()
    {
        return $this->token;
    }

    /**
     * @return null|string
     */
    public function getProviderKey()
    {
        return $this->providerKey;
    }
}


1			<?php
2			/**
3			* This file is part of the LdapToolsBundle package.
4			*
5			* (c) Chad Sikorra <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace LdapTools\Bundle\LdapToolsBundle\Event;
12
13			use Symfony\Component\EventDispatcher\Event;
14			use Symfony\Component\HttpFoundation\Request;
15			use Symfony\Component\HttpFoundation\Response;
16			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
17			use Symfony\Component\Security\Core\Exception\AuthenticationException;
18
19			/**
20			* Represents an authentication handler event, such as success or failure, where the response can be set.
21			*
22			* @author Chad Sikorra <[email protected]>
23			*/
24			class AuthenticationHandlerEvent extends Event
25			{
26			/**
27			* The event name that happens after the default authentication success handler is called.
28			*/
29			const SUCCESS = 'ldap_tools_bundle.guard.login.success';
30
31			/**
32			* The event name that happens after the default authentication failure handler is called.
33			*/
34			const FAILURE = 'ldap_tools_bundle.guard.login.failure';
35
36			/**
37			* The event name that happens when the entry point is called for the guard and returns a redirect/response.
38			*/
39			const START = 'ldap_tools_bundle.guard.login.start';
40
41			/**
42			* @var Response
43			*/
44			protected $response;
45
46			/**
47			* @var AuthenticationException\|null
48			*/
49			protected $exception;
50
51			/**
52			* @var Request
53			*/
54			protected $request;
55
56			/**
57			* @var TokenInterface\|null
58			*/
59			protected $token;
60
61			/**
62			* @var string\|null
63			*/
64			protected $providerKey;
65
66			/**
67			* @param Response $response
68			* @param Request $request
69			* @param null\|AuthenticationException $exception
70			* @param TokenInterface\|null $token
71			* @param string\|null $providerKey
72			*/
73			public function __construct(Response $response, Request $request, AuthenticationException $exception = null, TokenInterface $token = null, $providerKey = null)
			0 ignored issues – show Bug introduced 2017-03-23 23:33 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
74			{
75			$this->request = $request;
76			$this->response = $response;
77			$this->exception = $exception;
78			$this->token = $token;
79			$this->providerKey = $providerKey;
80			}
81
82			/**
83			* @return Response
84			*/
85			public function getResponse()
86			{
87			return $this->response;
88			}
89
90			/**
91			* @return Request
92			*/
93			public function getRequest()
94			{
95			return $this->request;
96			}
97
98			/**
99			* @param Response $response
100			* @return $this
101			*/
102			public function setResponse(Response $response)
103			{
104			$this->response = $response;
105
106			return $this;
107			}
108
109			/**
110			* @return AuthenticationException\|null
111			*/
112			public function getException()
113			{
114			return $this->exception;
115			}
116
117			/**
118			* @return null\|TokenInterface
119			*/
120			public function getToken()
121			{
122			return $this->token;
123			}
124
125			/**
126			* @return null\|string
127			*/
128			public function getProviderKey()
129			{
130			return $this->providerKey;
131			}
132			}
133

ldaptools / ldaptools-bundle

AuthenticationHandlerEvent::getResponse() A last analyzed 2018-06-07 22:03 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AuthenticationHandlerEvent::getResponse() A
last analyzed 2018-06-07 22:03 UTC