App::getSummary() - Code Metrics - Inspection of "refactoring" - Ne-Lexa/google-play-scraper - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — develop (29ed49)

by Alexey
created 2019-06-15 14:57 UTC
App::getSummary() A

↳ Parent: App
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php
declare(strict_types=1);

/**
 * @author   Ne-Lexa
 * @license  MIT
 * @link     https://github.com/Ne-Lexa/google-play-scraper
 */

namespace Nelexa\GPlay\Model;

use Nelexa\GPlay\Model\Builder\AppBuilder;

/**
 * Contains basic information about the application from the Google Play store.
 *
 * Some sections, such as search, similar applications, applications categories, etc. display
 * a list of applications with limited data. To get detailed information about the application,
 * you must call the appropriate method in the class {@see \Nelexa\GPlay\GPlayApps}.
 *
 * @see \Nelexa\GPlay\Model\AppId Application ID, application locale and country.
 * @see \Nelexa\GPlay\GPlayApps::search() Returns a list of applications from the Google Play
 *     store for a search query.
 * @see \Nelexa\GPlay\GPlayApps::getSimilarApps() Returns a list of similar applications in
 *     the Google Play store.
 * @see \Nelexa\GPlay\GPlayApps::getDeveloperApps() Returns a list of developer applications
 *     in the Google Play store.
 * @see \Nelexa\GPlay\GPlayApps::getAppsByCategory() Returns a list of applications with basic
 *     information from the category and collection of the Google Play store.
 */
class App extends AppId implements \JsonSerializable
{
    use JsonSerializableTrait;

    /** @var string Application name. */
    private $name;

    /** @var string|null Application summary. */
    private $summary;

    /** @var Developer Application developer. */
    private $developer;

    /** @var GoogleImage Application icon. */
    private $icon;

    /** @var float Application rating on a five-point scale. */
    private $score;

    /** @var string|null Price of the application or null if it is free. */
    private $priceText;

    /**
     * Creates an object containing basic information about the Android application.
     *
     * @param AppBuilder $builder Application builder.
     *
     * @throws \InvalidArgumentException If not enough required data in the builder.
     *
     * @ignore
     */
    public function __construct(AppBuilder $builder)
    {
        $this->validateBuilder($builder);

        parent::__construct(
            $builder->getId(),
            /** @scrutinizer ignore-type */ $builder->getId(),
            $builder->getLocale(),
            /** @scrutinizer ignore-type */ $builder->getLocale(),
            $builder->getCountry()
            /** @scrutinizer ignore-type */ $builder->getCountry()
        );
        $this->name = $builder->getName();
        $this->summary = $builder->getSummary();
        $this->developer = $builder->getDeveloper();
        $this->icon = $builder->getIcon();
        $this->score = $builder->getScore();
        $this->priceText = $builder->getPriceText();
    }

    /**
     * @param AppBuilder $builder
     */
    private function validateBuilder(AppBuilder $builder): void
    {
        if (empty($builder->getId())) {
            throw new \InvalidArgumentException('Application ID cannot be null or empty. Solution: $appBuilder->setId(...);');
        }
        if (empty($builder->getLocale())) {
            throw new \InvalidArgumentException('Locale cannot be null or empty. Solution: $appBuilder->setLocale(...);');
        }
        if (empty($builder->getCountry())) {
            throw new \InvalidArgumentException('Country cannot be null or empty. Solution: $appBuilder->setCountry(...);');
        }
        if (empty($builder->getName())) {
            throw new \InvalidArgumentException('The application name cannot be null or empty. Solution: $appBuilder->setName(...);');
        }
        if ($builder->getDeveloper() === null) {
            throw new \InvalidArgumentException('Application developer cannot be null. Solution: $appBuilder->setDeveloper(...);');
        }
        if ($builder->getIcon() === null) {
            throw new \InvalidArgumentException('Application icon cannot be null. Solution: $appBuilder->setIcon(...);');
        }
    }

    /**
     * Returns application name.
     *
     * @return string Application name.
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Returns application summary.
     *
     * @return string|null Application summary.
     */
    public function getSummary(): ?string
    {
        return $this->summary;
    }

    /**
     * Returns application developer
     *
     * @return Developer Application developer.
     */
    public function getDeveloper(): Developer
    {
        return $this->developer;
    }

    /**
     * Returns application icon.
     *
     * @return GoogleImage Application icon.
     */
    public function getIcon(): GoogleImage
    {
        return $this->icon;
    }

    /**
     * Returns application rating on a five-point scale.
     *
     * @return float Rating application.
     */
    public function getScore(): float
    {
        return $this->score;
    }

    /**
     * Returns the price of the application.
     *
     * @return string|null Application price or null if it is free.
     */
    public function getPriceText(): ?string
    {
        return $this->priceText;
    }

    /**
     * Checks that this application is free.
     *
     * @return bool `true` if the application is free and `false` if paid.
     */
    public function isFree(): bool
    {
        return $this->priceText === null;
    }

    /**
     * Creates a new application builder.
     *
     * @return AppBuilder Application builder.
     * @ignore
     */
    public static function newBuilder(): AppBuilder
    {
        return new AppBuilder();
    }

    /**
     * Returns class properties as an array.
     *
     * @return array Class properties as an array.
     */
    public function asArray(): array
    {
        return [
            'id' => $this->getId(),
            'url' => $this->getUrl(),
            'locale' => $this->getLocale(),
            'country' => $this->getCountry(),
            'name' => $this->name,
            'summary' => $this->summary,
            'developer' => $this->developer->asArray(),
            'icon' => $this->icon->getUrl(),
            'score' => $this->score,
            'priceText' => $this->priceText,
        ];
    }
}

Ne-Lexa / google-play-scraper

Branch — develop (29ed49)

App::getSummary() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
