EmailVerificationBroker::getRepository() - Code Metrics - Inspection of "Merge branch 'release/v0.0.4'" - rinvex/laravel-auth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( edb43e...425779 )

by Abdelrahman

created 2017-03-08 01:39 UTC

EmailVerificationBroker::getRepository() A

↳ Parent: EmailVerificationBroker

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/*
 * NOTICE OF LICENSE
 *
 * Part of the Rinvex Fort Package.
 *
 * This source file is subject to The MIT License (MIT)
 * that is bundled with this package in the LICENSE file.
 *
 * Package: Rinvex Fort Package
 * License: The MIT License (MIT)
 * Link:    https://rinvex.com
 */

declare(strict_types=1);

namespace Rinvex\Fort\Services;

use Closure;
use Illuminate\Support\Arr;
use UnexpectedValueException;
use Illuminate\Contracts\Auth\UserProvider;
use Rinvex\Fort\Contracts\CanVerifyEmailContract;
use Rinvex\Fort\Contracts\EmailVerificationBrokerContract;
use Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract;

class EmailVerificationBroker implements EmailVerificationBrokerContract
{
    /**
     * The verification token repository.
     *
     * @var \Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract
     */
    protected $tokens;

    /**
     * The user provider implementation.
     *
     * @var \Illuminate\Contracts\Auth\UserProvider
     */
    protected $users;

    /**
     * Create a new verification broker instance.
     *
     * @param \Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract $tokens
     * @param \Illuminate\Contracts\Auth\UserProvider                         $users
     */
    public function __construct(EmailVerificationTokenRepositoryContract $tokens, UserProvider $users)
    {
        $this->users = $users;
        $this->tokens = $tokens;
    }

    /**
     * {@inheritdoc}
     */
    public function sendVerificationLink(array $credentials)
    {
        // First we will check to see if we found a user at the given credentials and
        // if we did not we will redirect back to this current URI with a piece of
        // "flash" data in the session to indicate to the developers the errors.
        if (is_null($user = $this->getUser($credentials))) {
            return static::INVALID_USER;
        }

        // Once we have the verification token, we are ready to send the message out
        // to this user with a link for verification. We will then redirect back to
        // the current URI having nothing set in the session to indicate errors.
        $data = $this->tokens->getData($user, $token = $this->tokens->create($user));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $expiration = $this->tokens->getExpiration();

        // Returned token is hashed, and we need the
        // public token to be sent to the user
        $data['token'] = $token;

        $user->sendEmailVerificationNotification($data, $expiration);

        return static::LINK_SENT;
    }

    /**
     * {@inheritdoc}
     */
    public function verify(array $credentials, Closure $callback)
    {
        // If the responses from the validate method is not a user instance, we will
        // assume that it is a redirect and simply return it from this method and
        // the user is properly redirected having an error message on the post.
        $user = $this->validateVerification($credentials);

        if (! $user instanceof CanVerifyEmailContract) {
            return $user;
        }

        // Fire the email verification start event
        event('rinvex.fort.emailverification.start', [$user]);

        // Once the email has been verified, we'll call the given
        // callback, then we'll delete the token and return.
        $callback($user);

        $this->tokens->delete($user);

        // Fire the email verification success event
        event('rinvex.fort.emailverification.success', [$user]);

        return static::EMAIL_VERIFIED;
    }

    /**
     * Get the user for the given credentials.
     *
     * @param array $credentials
     *
     * @throws \UnexpectedValueException
     *
     * @return \Rinvex\Fort\Contracts\CanVerifyEmailContract

     */
    public function getUser(array $credentials)
    {
        $credentials = Arr::except($credentials, ['token']);

        $user = $this->users->retrieveByCredentials($credentials);

        if ($user && ! $user instanceof CanVerifyEmailContract) {
            throw new UnexpectedValueException('User must implement CanVerifyEmailContract interface.');
        }

        return $user;
    }

    /**
     * Create a new email verification token for the given user.
     *
     * @param \Rinvex\Fort\Contracts\CanVerifyEmailContract $user
     *
     * @return string
     */
    public function createToken(CanVerifyEmailContract $user)
    {
        return $this->tokens->create($user);
    }

    /**
     * Delete email verification tokens of the given user.
     *
     * @param \Rinvex\Fort\Contracts\CanVerifyEmailContract $user
     *
     * @return void
     */
    public function deleteToken(CanVerifyEmailContract $user)
    {
        $this->tokens->delete($user);
    }

    /**
     * Validate the given verification token.
     *
     * @param \Rinvex\Fort\Contracts\CanVerifyEmailContract $user
     * @param string                                        $token
     *
     * @return bool
     */
    public function tokenExists(CanVerifyEmailContract $user, $token)
    {
        return $this->tokens->exists($user, $token);
    }

    /**
     * Get the verification token repository implementation.
     *
     * @return \Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract
     */
    public function getRepository()
    {
        return $this->tokens;
    }

    /**
     * Validate an email verification for the given credentials.
     *
     * @param array $credentials
     *
     * @return \Rinvex\Fort\Contracts\CanVerifyEmailContract|string

     */
    protected function validateVerification(array $credentials)
    {
        if (is_null($user = $this->getUser($credentials))) {
            return static::INVALID_USER;
        }

        if (! $this->tokens->exists($user, $credentials['token'])) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return static::INVALID_TOKEN;
        }

        return $user;
    }
}


1			<?php
2
3			/*
4			* NOTICE OF LICENSE
5			*
6			* Part of the Rinvex Fort Package.
7			*
8			* This source file is subject to The MIT License (MIT)
9			* that is bundled with this package in the LICENSE file.
10			*
11			* Package: Rinvex Fort Package
12			* License: The MIT License (MIT)
13			* Link: https://rinvex.com
14			*/
15
16			declare(strict_types=1);
17
18			namespace Rinvex\Fort\Services;
19
20			use Closure;
21			use Illuminate\Support\Arr;
22			use UnexpectedValueException;
23			use Illuminate\Contracts\Auth\UserProvider;
24			use Rinvex\Fort\Contracts\CanVerifyEmailContract;
25			use Rinvex\Fort\Contracts\EmailVerificationBrokerContract;
26			use Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract;
27
28			class EmailVerificationBroker implements EmailVerificationBrokerContract
29			{
30			/**
31			* The verification token repository.
32			*
33			* @var \Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract
34			*/
35			protected $tokens;
36
37			/**
38			* The user provider implementation.
39			*
40			* @var \Illuminate\Contracts\Auth\UserProvider
41			*/
42			protected $users;
43
44			/**
45			* Create a new verification broker instance.
46			*
47			* @param \Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract $tokens
48			* @param \Illuminate\Contracts\Auth\UserProvider $users
49			*/
50			public function __construct(EmailVerificationTokenRepositoryContract $tokens, UserProvider $users)
51			{
52			$this->users = $users;
53			$this->tokens = $tokens;
54			}
55
56			/**
57			* {@inheritdoc}
58			*/
59			public function sendVerificationLink(array $credentials)
60			{
61			// First we will check to see if we found a user at the given credentials and
62			// if we did not we will redirect back to this current URI with a piece of
63			// "flash" data in the session to indicate to the developers the errors.
64			if (is_null($user = $this->getUser($credentials))) {
65			return static::INVALID_USER;
66			}
67
68			// Once we have the verification token, we are ready to send the message out
69			// to this user with a link for verification. We will then redirect back to
70			// the current URI having nothing set in the session to indicate errors.
71			$data = $this->tokens->getData($user, $token = $this->tokens->create($user));
			0 ignored issues – show Documentation introduced 2017-02-11 17:18 UTC by Report Bug Copy Issue Report `$user` is of type `object<Illuminate\Contracts\Auth\Authenticatable>`, but the function expects a `object<Rinvex\Fort\Contr...CanVerifyEmailContract>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2017-03-08 01:49 UTC by Report Bug Copy Issue Report The call to `EmailVerificationTokenRe...toryContract::getData()` has too many arguments starting with `$token = $this->tokens->create($user)`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
72			$expiration = $this->tokens->getExpiration();
73
74			// Returned token is hashed, and we need the
75			// public token to be sent to the user
76			$data['token'] = $token;
77
78			$user->sendEmailVerificationNotification($data, $expiration);
79
80			return static::LINK_SENT;
81			}
82
83			/**
84			* {@inheritdoc}
85			*/
86			public function verify(array $credentials, Closure $callback)
87			{
88			// If the responses from the validate method is not a user instance, we will
89			// assume that it is a redirect and simply return it from this method and
90			// the user is properly redirected having an error message on the post.
91			$user = $this->validateVerification($credentials);
92
93			if (! $user instanceof CanVerifyEmailContract) {
94			return $user;
95			}
96
97			// Fire the email verification start event
98			event('rinvex.fort.emailverification.start', [$user]);
99
100			// Once the email has been verified, we'll call the given
101			// callback, then we'll delete the token and return.
102			$callback($user);
103
104			$this->tokens->delete($user);
105
106			// Fire the email verification success event
107			event('rinvex.fort.emailverification.success', [$user]);
108
109			return static::EMAIL_VERIFIED;
110			}
111
112			/**
113			* Get the user for the given credentials.
114			*
115			* @param array $credentials
116			*
117			* @throws \UnexpectedValueException
118			*
119			* @return \Rinvex\Fort\Contracts\CanVerifyEmailContract
			0 ignored issues – show Documentation introduced 2017-02-11 17:18 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\Contracts\Auth\Authenticatable\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
120			*/
121			public function getUser(array $credentials)
122			{
123			$credentials = Arr::except($credentials, ['token']);
124
125			$user = $this->users->retrieveByCredentials($credentials);
126
127			if ($user && ! $user instanceof CanVerifyEmailContract) {
128			throw new UnexpectedValueException('User must implement CanVerifyEmailContract interface.');
129			}
130
131			return $user;
132			}
133
134			/**
135			* Create a new email verification token for the given user.
136			*
137			* @param \Rinvex\Fort\Contracts\CanVerifyEmailContract $user
138			*
139			* @return string
140			*/
141			public function createToken(CanVerifyEmailContract $user)
142			{
143			return $this->tokens->create($user);
144			}
145
146			/**
147			* Delete email verification tokens of the given user.
148			*
149			* @param \Rinvex\Fort\Contracts\CanVerifyEmailContract $user
150			*
151			* @return void
152			*/
153			public function deleteToken(CanVerifyEmailContract $user)
154			{
155			$this->tokens->delete($user);
156			}
157
158			/**
159			* Validate the given verification token.
160			*
161			* @param \Rinvex\Fort\Contracts\CanVerifyEmailContract $user
162			* @param string $token
163			*
164			* @return bool
165			*/
166			public function tokenExists(CanVerifyEmailContract $user, $token)
167			{
168			return $this->tokens->exists($user, $token);
169			}
170
171			/**
172			* Get the verification token repository implementation.
173			*
174			* @return \Rinvex\Fort\Contracts\EmailVerificationTokenRepositoryContract
175			*/
176			public function getRepository()
177			{
178			return $this->tokens;
179			}
180
181			/**
182			* Validate an email verification for the given credentials.
183			*
184			* @param array $credentials
185			*
186			* @return \Rinvex\Fort\Contracts\CanVerifyEmailContract\|string
			0 ignored issues – show Documentation introduced 2017-03-08 01:49 UTC by Report Bug Copy Issue Report Should the return type not be `string\|\Illuminate\Contracts\Auth\Authenticatable`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
187			*/
188			protected function validateVerification(array $credentials)
189			{
190			if (is_null($user = $this->getUser($credentials))) {
191			return static::INVALID_USER;
192			}
193
194			if (! $this->tokens->exists($user, $credentials['token'])) {
			0 ignored issues – show Documentation introduced 2017-02-11 17:18 UTC by Report Bug Copy Issue Report `$user` is of type `object<Illuminate\Contracts\Auth\Authenticatable>`, but the function expects a `object<Rinvex\Fort\Contr...CanVerifyEmailContract>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
195			return static::INVALID_TOKEN;
196			}
197
198			return $user;
199			}
200			}
201

rinvex / laravel-auth

Push — master ( edb43e...425779 )

EmailVerificationBroker::getRepository() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like