XApiClient - Code Metrics - php-xapi/client - Measure and Improve Code Quality continuously with Scrutinizer

XApiClient A
last analyzed 2021-03-24 14:21 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	5
dl	0
loc	71
ccs	0
cts	42
cp	0
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	getStatementsApiClient()	10	1
A	getStateApiClient()	9	1
A	getActivityProfileApiClient()	8	1
A	getAgentProfileApiClient()	9	1

<?php

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

namespace Xabbuh\XApi\Client;

use Xabbuh\XApi\Client\Api\ActivityProfileApiClient;
use Xabbuh\XApi\Client\Api\AgentProfileApiClient;
use Xabbuh\XApi\Client\Api\ApiClient;
use Xabbuh\XApi\Client\Api\StateApiClient;
use Xabbuh\XApi\Client\Api\StatementsApiClient;
use Xabbuh\XApi\Client\Request\HandlerInterface;
use Xabbuh\XApi\Serializer\SerializerRegistryInterface;

/**
 * An Experience API client.
 *
 * @author Christian Flothmann <[email protected]>
 */
final class XApiClient implements XApiClientInterface
{
    /**
     * @var SerializerRegistryInterface
     */
    private $serializerRegistry;

    /**
     * @param HandlerInterface            $requestHandler     The HTTP request handler
     * @param SerializerRegistryInterface $serializerRegistry The serializer registry
     * @param string                      $version            The xAPI version
     */
    public function __construct(HandlerInterface $requestHandler, SerializerRegistryInterface $serializerRegistry, $version)
    {
        $this->requestHandler = $requestHandler;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->serializerRegistry = $serializerRegistry;
        $this->version = $version;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * {@inheritDoc}
     */
    public function getStatementsApiClient()
    {
        return new StatementsApiClient(
            $this->requestHandler,
            $this->version,
            $this->serializerRegistry->getStatementSerializer(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->serializerRegistry->getStatementResultSerializer(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->serializerRegistry->getActorSerializer()
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        );
    }

    /**
     * {@inheritDoc}
     */
    public function getStateApiClient()
    {
        return new StateApiClient(
            $this->requestHandler,
            $this->version,
            $this->serializerRegistry->getDocumentDataSerializer(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->serializerRegistry->getActorSerializer()
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        );
    }

    /**
     * {@inheritDoc}
     */
    public function getActivityProfileApiClient()
    {
        return new ActivityProfileApiClient(
            $this->requestHandler,
            $this->version,
            $this->serializerRegistry->getDocumentDataSerializer()
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        );
    }

    /**
     * {@inheritDoc}
     */
    public function getAgentProfileApiClient()
    {
        return new AgentProfileApiClient(
            $this->requestHandler,
            $this->version,
            $this->serializerRegistry->getDocumentDataSerializer(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->serializerRegistry->getActorSerializer()
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        );
    }
}


1			<?php
2
3			/*
4			* This file is part of the xAPI package.
5			*
6			* (c) Christian Flothmann <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Xabbuh\XApi\Client;
13
14			use Xabbuh\XApi\Client\Api\ActivityProfileApiClient;
15			use Xabbuh\XApi\Client\Api\AgentProfileApiClient;
16			use Xabbuh\XApi\Client\Api\ApiClient;
17			use Xabbuh\XApi\Client\Api\StateApiClient;
18			use Xabbuh\XApi\Client\Api\StatementsApiClient;
19			use Xabbuh\XApi\Client\Request\HandlerInterface;
20			use Xabbuh\XApi\Serializer\SerializerRegistryInterface;
21
22			/**
23			* An Experience API client.
24			*
25			* @author Christian Flothmann <[email protected]>
26			*/
27			final class XApiClient implements XApiClientInterface
28			{
29			/**
30			* @var SerializerRegistryInterface
31			*/
32			private $serializerRegistry;
33
34			/**
35			* @param HandlerInterface $requestHandler The HTTP request handler
36			* @param SerializerRegistryInterface $serializerRegistry The serializer registry
37			* @param string $version The xAPI version
38			*/
39			public function __construct(HandlerInterface $requestHandler, SerializerRegistryInterface $serializerRegistry, $version)
40			{
41			$this->requestHandler = $requestHandler;
			0 ignored issues – show Bug introduced 2016-09-26 19:49 UTC by Report Bug Copy Issue Report The property `requestHandler` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
42			$this->serializerRegistry = $serializerRegistry;
43			$this->version = $version;
			0 ignored issues – show Bug introduced 2016-09-26 19:49 UTC by Report Bug Copy Issue Report The property `version` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
44			}
45
46			/**
47			* {@inheritDoc}
48			*/
49			public function getStatementsApiClient()
50			{
51			return new StatementsApiClient(
52			$this->requestHandler,
53			$this->version,
54			$this->serializerRegistry->getStatementSerializer(),
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistr...etStatementSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
55			$this->serializerRegistry->getStatementResultSerializer(),
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistr...ementResultSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
56			$this->serializerRegistry->getActorSerializer()
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistry->getActorSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
57			);
58			}
59
60			/**
61			* {@inheritDoc}
62			*/
63			public function getStateApiClient()
64			{
65			return new StateApiClient(
66			$this->requestHandler,
67			$this->version,
68			$this->serializerRegistry->getDocumentDataSerializer(),
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistr...ocumentDataSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
69			$this->serializerRegistry->getActorSerializer()
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistry->getActorSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
70			);
71			}
72
73			/**
74			* {@inheritDoc}
75			*/
76			public function getActivityProfileApiClient()
77			{
78			return new ActivityProfileApiClient(
79			$this->requestHandler,
80			$this->version,
81			$this->serializerRegistry->getDocumentDataSerializer()
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistr...ocumentDataSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
82			);
83			}
84
85			/**
86			* {@inheritDoc}
87			*/
88			public function getAgentProfileApiClient()
89			{
90			return new AgentProfileApiClient(
91			$this->requestHandler,
92			$this->version,
93			$this->serializerRegistry->getDocumentDataSerializer(),
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistr...ocumentDataSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
94			$this->serializerRegistry->getActorSerializer()
			0 ignored issues – show Bug introduced 2016-09-28 15:39 UTC by Report Bug Copy Issue Report It seems like `$this->serializerRegistry->getActorSerializer()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
95			);
96			}
97			}
98

php-xapi / client

XApiClient A last analyzed 2021-03-24 14:21 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

XApiClient A
last analyzed 2021-03-24 14:21 UTC