UserService::listBalances() - Code Metrics - Inspection of "Hw demo" - romeritoCL/paypal-playground - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#33)

by Cesar

created 2021-05-18 21:56 UTC

UserService::listBalances() A

↳ Parent: UserService

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace App\Service\Hyperwallet;

use Exception;
use DateTime;
use Hyperwallet\Exception\HyperwalletApiException;
use Hyperwallet\Model\AuthenticationToken;
use Hyperwallet\Model\User;
use Hyperwallet\Response\ListResponse;

/**
 * Class UserService
 * @package App\Service\Hyperwallet
 */
class UserService extends AbstractHyperwalletService
{
    /**
     * @return ListResponse
     *
     * @throws HyperwalletApiException
     */
    public function list(): ListResponse
    {
        return $this->client->listUsers([
            'status' => ['ACTIVATED', 'PRE_ACTIVATED'],
        ]);
    }

    /**
     * @param array $userParameters
     * @return User | Exception
     */
    public function create(array $userParameters)
    {
        try {
            $user = new User($userParameters);
            return $this->client->createUser($user);
        } catch (Exception $exception) {
            return $exception;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * @param array $userParameters
     * @return User | Exception
     */
    public function update(array $userParameters)
    {
        try {
            $user = new User($userParameters);
            $user
                ->setFirstName($userParameters['firstName'])
                ->setLastName($userParameters['lastName'])
                ->setEmail($userParameters['email'])
                ->setDateOfBirth(new Datetime($userParameters['dateOfBirth']))
                ->setClientUserId($userParameters['clientUserId'])
                ->setLanguage($userParameters['language'])
            ;
            return $this->client->updateUser($user);
        } catch (Exception $exception) {
            return $exception;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * @param string $userToken
     * @return Exception|User
     */
    public function get(string $userToken)
    {
        try {
            return $this->client->getUser($userToken);
        } catch (Exception $exception) {
            return $exception;
        }
    }

    /**
     * @param string $userToken
     * @return Exception|ListResponse
     */
    public function listTransferMethods(string $userToken)
    {
        try {
            return $this->client->listTransferMethods($userToken);
        } catch (Exception $exception) {
            return $exception;
        }
    }

    /**
     * @param string $userToken
     * @return Exception|ListResponse
     */
    public function listBalances(string $userToken)
    {
        try {
            return $this->client->listBalancesForUser($userToken);
        } catch (Exception $exception) {
            return $exception;
        }
    }

    /**
     * @param string $userToken
     * @return Exception|AuthenticationToken
     */
    public function getAuthenticationToken(string $userToken)
    {
        try {
            return $this->client->getAuthenticationToken($userToken);
        } catch (Exception $exception) {
            return $exception;
        }
    }
}


1			<?php
2
3			namespace App\Service\Hyperwallet;
4
5			use Exception;
6			use DateTime;
7			use Hyperwallet\Exception\HyperwalletApiException;
8			use Hyperwallet\Model\AuthenticationToken;
9			use Hyperwallet\Model\User;
10			use Hyperwallet\Response\ListResponse;
11
12			/**
13			* Class UserService
14			* @package App\Service\Hyperwallet
15			*/
16			class UserService extends AbstractHyperwalletService
17			{
18			/**
19			* @return ListResponse
20			*
21			* @throws HyperwalletApiException
22			*/
23			public function list(): ListResponse
24			{
25			return $this->client->listUsers([
26			'status' => ['ACTIVATED', 'PRE_ACTIVATED'],
27			]);
28			}
29
30			/**
31			* @param array $userParameters
32			* @return User \| Exception
33			*/
34			public function create(array $userParameters)
35			{
36			try {
37			$user = new User($userParameters);
38			return $this->client->createUser($user);
39			} catch (Exception $exception) {
40			return $exception;
			0 ignored issues – show Bug Best Practice introduced 2021-02-08 22:55 UTC by Report Bug Copy Issue Report The return type of `return $exception;` (`Exception`) is incompatible with the return type documented by `App\Service\Hyperwallet\UserService::create` of type `Hyperwallet\Model\User`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
41			}
42			}
43
44			/**
45			* @param array $userParameters
46			* @return User \| Exception
47			*/
48			public function update(array $userParameters)
49			{
50			try {
51			$user = new User($userParameters);
52			$user
53			->setFirstName($userParameters['firstName'])
54			->setLastName($userParameters['lastName'])
55			->setEmail($userParameters['email'])
56			->setDateOfBirth(new Datetime($userParameters['dateOfBirth']))
57			->setClientUserId($userParameters['clientUserId'])
58			->setLanguage($userParameters['language'])
59			;
60			return $this->client->updateUser($user);
61			} catch (Exception $exception) {
62			return $exception;
			0 ignored issues – show Bug Best Practice introduced 2021-05-18 21:58 UTC by Report Bug Copy Issue Report The return type of `return $exception;` (`Exception`) is incompatible with the return type documented by `App\Service\Hyperwallet\UserService::update` of type `Hyperwallet\Model\User`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
63			}
64			}
65
66			/**
67			* @param string $userToken
68			* @return Exception\|User
69			*/
70			public function get(string $userToken)
71			{
72			try {
73			return $this->client->getUser($userToken);
74			} catch (Exception $exception) {
75			return $exception;
76			}
77			}
78
79			/**
80			* @param string $userToken
81			* @return Exception\|ListResponse
82			*/
83			public function listTransferMethods(string $userToken)
84			{
85			try {
86			return $this->client->listTransferMethods($userToken);
87			} catch (Exception $exception) {
88			return $exception;
89			}
90			}
91
92			/**
93			* @param string $userToken
94			* @return Exception\|ListResponse
95			*/
96			public function listBalances(string $userToken)
97			{
98			try {
99			return $this->client->listBalancesForUser($userToken);
100			} catch (Exception $exception) {
101			return $exception;
102			}
103			}
104
105			/**
106			* @param string $userToken
107			* @return Exception\|AuthenticationToken
108			*/
109			public function getAuthenticationToken(string $userToken)
110			{
111			try {
112			return $this->client->getAuthenticationToken($userToken);
113			} catch (Exception $exception) {
114			return $exception;
115			}
116			}
117			}
118

romeritoCL / paypal-playground

Pull Request — master (#33)

UserService::listBalances() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like