ErrorTracker::getModel() - Code Metrics - Inspection of "Moving all the tracking stuff to TrackingManager" - ARCANEDEV/LaravelTracker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by ARCANEDEV

created 2016-12-08 19:35 UTC

ErrorTracker::getModel() A

↳ Parent: ErrorTracker

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\LaravelTracker\Trackers;

use Arcanedev\LaravelTracker\Contracts\Trackers\ErrorTracker as ErrorTrackerContract;
use Arcanedev\LaravelTracker\Models\AbstractModel;
use Exception;

/**
 * Class     ErrorTracker
 *
 * @package  Arcanedev\LaravelTracker\Trackers
 * @author   ARCANEDEV <[email protected]>
 */
class ErrorTracker extends AbstractTracker implements ErrorTrackerContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Getters and Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the model.
     *
     * @return \Arcanedev\LaravelTracker\Models\Error
     */
    protected function getModel()
    {
        return $this->makeModel(AbstractModel::MODEL_ERROR);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Track the exception error.
     *
     * @param  \Exception  $exception
     *
     * @return int
     */
    public function track(Exception $exception)
    {
        return $this->getModel()
                    ->firstOrCreate([
                        'code'    => $this->getCode($exception),
                        'message' => $exception->getMessage(),
                    ])->id;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the code from the exception.
     *
     * @param  \Exception  $exception
     *
     * @return int|mixed|null
     */
    public function getCode(Exception $exception)
    {
        if (method_exists($exception, 'getCode') && $code = $exception->getCode())
            return $code;

        if (method_exists($exception, 'getStatusCode') && $code = $exception->getStatusCode())
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            return $code;

        return null;
    }
}


1		<?php namespace Arcanedev\LaravelTracker\Trackers;
2
3		use Arcanedev\LaravelTracker\Contracts\Trackers\ErrorTracker as ErrorTrackerContract;
4		use Arcanedev\LaravelTracker\Models\AbstractModel;
5		use Exception;
6
7		/**
8		* Class ErrorTracker
9		*
10		* @package Arcanedev\LaravelTracker\Trackers
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class ErrorTracker extends AbstractTracker implements ErrorTrackerContract
14		{
15		/* ------------------------------------------------------------------------------------------------
16		\| Getters and Setters
17		\| ------------------------------------------------------------------------------------------------
18		*/
19		/**
20		* Get the model.
21		*
22		* @return \Arcanedev\LaravelTracker\Models\Error
23		*/
24	10	protected function getModel()
25		{
26	10	return $this->makeModel(AbstractModel::MODEL_ERROR);
27		}
28
29		/* ------------------------------------------------------------------------------------------------
30		\| Main Functions
31		\| ------------------------------------------------------------------------------------------------
32		*/
33		/**
34		* Track the exception error.
35		*
36		* @param \Exception $exception
37		*
38		* @return int
39		*/
40	10	public function track(Exception $exception)
41		{
42	10	return $this->getModel()
43	10	->firstOrCreate([
44	10	'code' => $this->getCode($exception),
45	10	'message' => $exception->getMessage(),
46	10	])->id;
47		}
48
49		/* ------------------------------------------------------------------------------------------------
50		\| Other Functions
51		\| ------------------------------------------------------------------------------------------------
52		*/
53		/**
54		* Get the code from the exception.
55		*
56		* @param \Exception $exception
57		*
58		* @return int\|mixed\|null
59		*/
60	10	public function getCode(Exception $exception)
61		{
62	10	if (method_exists($exception, 'getCode') && $code = $exception->getCode())
63	8	return $code;
64
65	4	if (method_exists($exception, 'getStatusCode') && $code = $exception->getStatusCode())
		0 ignored issues – show Bug introduced 2016-12-08 17:57 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getStatusCode()` does only exist in the following sub-classes of `Exception`: `MaxMind\Exception\AuthenticationException`, `MaxMind\Exception\HttpException`, `MaxMind\Exception\InsufficientFundsException`, `MaxMind\Exception\InvalidRequestException`, `MaxMind\Exception\IpAddressNotFoundException`, `MaxMind\Exception\PermissionRequiredException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
66	4	return $code;
67
68		return null;
69		}
70		}
71

ARCANEDEV / LaravelTracker

Pull Request — master (#2)

ErrorTracker::getModel() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like