AbstractURLHandler - Code Metrics - Inspection of "Merge branch '6.13' into 7.0" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 7.0 ( 82418c...c56049 )

by André

created 2017-12-15 21:57 UTC

AbstractURLHandler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

Metric	Value
dl	0
loc	57
rs	10
c	0
b	0
f	0
wmc	5
lcom	2
cbo	7

4 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
	getOptionsResolver()	1	?
A	setOptions()	8	2
A	setUrlStatus()	14	2

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Bundle\EzPublishCoreBundle\URLChecker\Handler;

use DateTime;
use Exception;
use eZ\Bundle\EzPublishCoreBundle\URLChecker\URLHandlerInterface;
use eZ\Publish\API\Repository\URLService;
use eZ\Publish\API\Repository\Values\URL\URL;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;

abstract class AbstractURLHandler implements URLHandlerInterface
{
    use LoggerAwareTrait;

    /** @var \eZ\Publish\API\Repository\URLService */
    protected $urlService;

    /** @var array */
    protected $options;

    public function __construct(URLService $urlService)
    {
        $this->logger = new NullLogger();
        $this->urlService = $urlService;
        $this->options = $this->getOptionsResolver()->resolve();
    }

    /**
     * Returns options resolver.
     *
     * @return \Symfony\Component\OptionsResolver\OptionsResolver
     */
    abstract protected function getOptionsResolver();

    /**
     * {@inheritdoc}
     */
    public function setOptions(array $options = null)
    {
        if ($options === null) {
            $options = [];
        }

        $this->options = $this->getOptionsResolver()->resolve($options);
    }

    /**
     * Sets URL status.
     *
     * @param \eZ\Publish\API\Repository\Values\URL\URL $url
     * @param bool $isValid
     */
    protected function setUrlStatus(URL $url, $isValid)
    {
        try {
            $updateStruct = $this->urlService->createUpdateStruct();
            $updateStruct->isValid = $isValid;
            $updateStruct->lastChecked = new DateTime();

            $this->urlService->updateUrl($url, $updateStruct);

            $this->logger->info(sprintf('URL id = %d (%s) was checked (valid = %s)', $url->id, $url->url, (int) $isValid));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } catch (Exception $e) {
            $this->logger->error(sprintf('Cannot update URL id = %d status: %s', $url->id, $url->url));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5			* @license For full copyright and license information view LICENSE file distributed with this source code.
6			*/
7			namespace eZ\Bundle\EzPublishCoreBundle\URLChecker\Handler;
8
9			use DateTime;
10			use Exception;
11			use eZ\Bundle\EzPublishCoreBundle\URLChecker\URLHandlerInterface;
12			use eZ\Publish\API\Repository\URLService;
13			use eZ\Publish\API\Repository\Values\URL\URL;
14			use Psr\Log\LoggerAwareTrait;
15			use Psr\Log\NullLogger;
16
17			abstract class AbstractURLHandler implements URLHandlerInterface
18			{
19			use LoggerAwareTrait;
20
21			/** @var \eZ\Publish\API\Repository\URLService */
22			protected $urlService;
23
24			/** @var array */
25			protected $options;
26
27			public function __construct(URLService $urlService)
28			{
29			$this->logger = new NullLogger();
30			$this->urlService = $urlService;
31			$this->options = $this->getOptionsResolver()->resolve();
32			}
33
34			/**
35			* Returns options resolver.
36			*
37			* @return \Symfony\Component\OptionsResolver\OptionsResolver
38			*/
39			abstract protected function getOptionsResolver();
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function setOptions(array $options = null)
45			{
46			if ($options === null) {
47			$options = [];
48			}
49
50			$this->options = $this->getOptionsResolver()->resolve($options);
51			}
52
53			/**
54			* Sets URL status.
55			*
56			* @param \eZ\Publish\API\Repository\Values\URL\URL $url
57			* @param bool $isValid
58			*/
59			protected function setUrlStatus(URL $url, $isValid)
60			{
61			try {
62			$updateStruct = $this->urlService->createUpdateStruct();
63			$updateStruct->isValid = $isValid;
64			$updateStruct->lastChecked = new DateTime();
65
66			$this->urlService->updateUrl($url, $updateStruct);
67
68			$this->logger->info(sprintf('URL id = %d (%s) was checked (valid = %s)', $url->id, $url->url, (int) $isValid));
			0 ignored issues – show Documentation introduced 2017-12-15 22:09 UTC by Report Bug Copy Issue Report The property `$id` is declared protected in `eZ\Publish\API\Repository\Values\URL\URL`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-12-15 22:09 UTC by Report Bug Copy Issue Report The property `$url` is declared protected in `eZ\Publish\API\Repository\Values\URL\URL`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
69			} catch (Exception $e) {
70			$this->logger->error(sprintf('Cannot update URL id = %d status: %s', $url->id, $url->url));
			0 ignored issues – show Documentation introduced 2017-12-15 22:09 UTC by Report Bug Copy Issue Report The property `$id` is declared protected in `eZ\Publish\API\Repository\Values\URL\URL`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-12-15 22:09 UTC by Report Bug Copy Issue Report The property `$url` is declared protected in `eZ\Publish\API\Repository\Values\URL\URL`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
71			}
72			}
73			}
74

ezsystems / ezpublish-kernel

Push — 7.0 ( 82418c...c56049 )

AbstractURLHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like