GoogleBooksService - Code Metrics - Inspection of "Update .htaccess" - scriptotek/colligator-backend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8bfd95...2626ba )

by Dan Michael O.

created 2016-12-11 12:00 UTC

GoogleBooksService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	10
c	0
b	0
f	0
lcom	1
cbo	4
dl	0
loc	52
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	get()	11	4
B	enrich()	29	5

<?php

namespace Colligator;

use Scriptotek\GoogleBooks\GoogleBooks;
use Scriptotek\GoogleBooks\Exceptions\UsageRateExceeded;

class GoogleBooksService implements EnrichmentService
{
    public static $serviceName = 'googlebooks';
    protected $books;

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

    protected function get($isbns)
    {
        foreach ($isbns as $isbn) {
            $volume = $this->books->volumes->byIsbn($isbn);
            \Log::debug('[GoogleBooksService] - ' . $isbn . ': ' . (is_null($volume) ? 'not found' : 'found'));
            if (!is_null($volume)) {
                return $volume;
            }
        }
        return null;
    }

    public function enrich(Document $doc)
    {
        \Log::debug('[GoogleBooksService] Checking document ' . $doc->id);
<?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.");
        }
    }

}

        $volume = $this->get($doc->bibliographic['isbns']);
<?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.");
        }
    }

}

        // Delete old
        $doc->enrichmentsByService(self::$serviceName)
            ->delete();

        // Insert
        $doc->enrichments()->create([
            'document_version' => sha1(json_encode($doc->bibliographic)),
<?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.");
        }
    }

}
            'service_name' => self::$serviceName,
            'service_data' => $volume,
        ]);

        if ($volume) {
            $cover_url = $volume->getCover();
            if (!is_null($cover_url) && is_null($doc->cover)) {
<?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.");
        }
    }

}
                \Log::debug('[GoogleBooksService] Setting new cover to document #' . $doc->id);
<?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.");
        }
    }

}
                try {
                    $doc->storeCover($cover_url);
                } catch (\ErrorException $e) {
                    \Log::error('[GoogleBooksService] Failed to store cover: ' . $cover_url . "\n" . $e->getMessage());
                }
            }
        }
    }
}


1			<?php
2
3			namespace Colligator;
4
5			use Scriptotek\GoogleBooks\GoogleBooks;
6			use Scriptotek\GoogleBooks\Exceptions\UsageRateExceeded;
7
8			class GoogleBooksService implements EnrichmentService
9			{
10			public static $serviceName = 'googlebooks';
11			protected $books;
12
13			public function __construct(GoogleBooks $books)
14			{
15			$this->books = $books;
16			}
17
18			protected function get($isbns)
19			{
20			foreach ($isbns as $isbn) {
21			$volume = $this->books->volumes->byIsbn($isbn);
22			\Log::debug('[GoogleBooksService] - ' . $isbn . ': ' . (is_null($volume) ? 'not found' : 'found'));
23			if (!is_null($volume)) {
24			return $volume;
25			}
26			}
27			return null;
28			}
29
30			public function enrich(Document $doc)
31			{
32			\Log::debug('[GoogleBooksService] Checking document ' . $doc->id);
			0 ignored issues – show Documentation introduced 2016-12-11 12:12 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Colligator\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
33
34			$volume = $this->get($doc->bibliographic['isbns']);
			0 ignored issues – show Documentation introduced 2016-12-11 12:12 UTC by Report Bug Copy Issue Report The property `bibliographic` does not exist on `object<Colligator\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
35
36			// Delete old
37			$doc->enrichmentsByService(self::$serviceName)
38			->delete();
39
40			// Insert
41			$doc->enrichments()->create([
42			'document_version' => sha1(json_encode($doc->bibliographic)),
			0 ignored issues – show Documentation introduced 2016-12-11 12:12 UTC by Report Bug Copy Issue Report The property `bibliographic` does not exist on `object<Colligator\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
43			'service_name' => self::$serviceName,
44			'service_data' => $volume,
45			]);
46
47			if ($volume) {
48			$cover_url = $volume->getCover();
49			if (!is_null($cover_url) && is_null($doc->cover)) {
			0 ignored issues – show Documentation introduced 2016-12-11 12:12 UTC by Report Bug Copy Issue Report The property `cover` does not exist on `object<Colligator\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
50			\Log::debug('[GoogleBooksService] Setting new cover to document #' . $doc->id);
			0 ignored issues – show Documentation introduced 2016-12-11 12:12 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Colligator\Document>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
51			try {
52			$doc->storeCover($cover_url);
53			} catch (\ErrorException $e) {
54			\Log::error('[GoogleBooksService] Failed to store cover: ' . $cover_url . "\n" . $e->getMessage());
55			}
56			}
57			}
58			}
59			}
60

scriptotek / colligator-backend

Push — master ( 8bfd95...2626ba )

GoogleBooksService A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like