TransferService::list() - Code Metrics - Inspection of "Merge pull request #33 from romeritoCL/hw-demo" - romeritoCL/paypal-playground - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 93b855...faa581 )

by Cesar

created 2021-05-18 21:59 UTC

TransferService::list() A

↳ Parent: TransferService

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace App\Service\Hyperwallet;

use Exception;
use Hyperwallet\Exception\HyperwalletApiException;
use Hyperwallet\Model\Transfer;
use Hyperwallet\Model\TransferStatusTransition;
use Hyperwallet\Response\ListResponse;

/**
 * Class TransferService
 * @package App\Service\Hyperwallet
 */
class TransferService extends AbstractHyperwalletService
{
    /**
     * @return ListResponse
     *
     * @throws HyperwalletApiException
     */
    public function list(): ListResponse
    {
        return $this->client->listTransfers();
    }

    /**
     * @param array $transferDetails
     * @return Transfer | Exception
     */
    public function create(array $transferDetails)
    {
        try {
            $transfer = new Transfer($transferDetails);
            return $this->client->createTransfer($transfer);
        } 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 $transferToken
     * @return Exception | Transfer
     */
    public function get(string $transferToken)
    {
        try {
            return $this->client->getTransfer($transferToken);
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());
}
        } catch (Exception $exception) {
            return $exception;
        }
    }

    /**
     * @param string $transferToken
     * @return Exception | TransferStatusTransition
     */
    public function commit(string $transferToken)
    {
        try {
            return $this->client->createTransferStatusTransition(
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());
}
                $transferToken,
                (new TransferStatusTransition())

                    ->setTransition("SCHEDULED")
            );
        } catch (Exception $exception) {
            return $exception;
        }
    }
}


1			<?php
2
3			namespace App\Service\Hyperwallet;
4
5			use Exception;
6			use Hyperwallet\Exception\HyperwalletApiException;
7			use Hyperwallet\Model\Transfer;
8			use Hyperwallet\Model\TransferStatusTransition;
9			use Hyperwallet\Response\ListResponse;
10
11			/**
12			* Class TransferService
13			* @package App\Service\Hyperwallet
14			*/
15			class TransferService extends AbstractHyperwalletService
16			{
17			/**
18			* @return ListResponse
19			*
20			* @throws HyperwalletApiException
21			*/
22			public function list(): ListResponse
23			{
24			return $this->client->listTransfers();
25			}
26
27			/**
28			* @param array $transferDetails
29			* @return Transfer \| Exception
30			*/
31			public function create(array $transferDetails)
32			{
33			try {
34			$transfer = new Transfer($transferDetails);
35			return $this->client->createTransfer($transfer);
36			} catch (Exception $exception) {
37			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\TransferService::create` of type `Hyperwallet\Model\Transfer`. 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...
38			}
39			}
40
41			/**
42			* @param string $transferToken
43			* @return Exception \| Transfer
44			*/
45			public function get(string $transferToken)
46			{
47			try {
48			return $this->client->getTransfer($transferToken);
			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 $this->client->ge...ansfer($transferToken);` (`Hyperwallet\Model\Transfer`) is incompatible with the return type documented by `App\Service\Hyperwallet\TransferService::get` of type `Exception`. 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...
49			} catch (Exception $exception) {
50			return $exception;
51			}
52			}
53
54			/**
55			* @param string $transferToken
56			* @return Exception \| TransferStatusTransition
57			*/
58			public function commit(string $transferToken)
59			{
60			try {
61			return $this->client->createTransferStatusTransition(
			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 $this->client->cr...ansition('SCHEDULED'));` (`Hyperwallet\Model\TransferStatusTransition`) is incompatible with the return type documented by `App\Service\Hyperwallet\TransferService::commit` of type `Exception`. 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...
62			$transferToken,
63			(new TransferStatusTransition())
			0 ignored issues – show Compatibility introduced 2021-05-18 21:58 UTC by Report Bug Copy Issue Report `(new \Hyperwallet\Model\...Transition('SCHEDULED')` of type `object<Hyperwallet\Model\StatusTransition>` is not a sub-type of `object<Hyperwallet\Model...ansferStatusTransition>`. It seems like you assume a child class of the class `Hyperwallet\Model\StatusTransition` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
64			->setTransition("SCHEDULED")
65			);
66			} catch (Exception $exception) {
67			return $exception;
68			}
69			}
70			}
71

romeritoCL / paypal-playground

Push — master ( 93b855...faa581 )

TransferService::list() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like