BrowscapPHP\Helper\IniLoader

Complexity

Total Complexity

5

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

84.62%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setRemoteFilename()	0	13	2
A	getRemoteIniUrl()	0	4	1
A	getRemoteTimeUrl()	0	4	1
A	getRemoteVersionUrl()	0	4	1

<?php
declare(strict_types=1);

namespace BrowscapPHP\Helper;

/**
 * class to load the browscap.ini
 */
final class IniLoader
{
    const PHP_INI_LITE = 'Lite_PHP_BrowscapINI';
    const PHP_INI_FULL = 'Full_PHP_BrowscapINI';
    const PHP_INI      = 'PHP_BrowscapINI';

    /**
     * The location from which download the ini file. The placeholder for the file should be represented by a %s.
     *
     * @var string
     */
    private $remoteIniUrl     = 'http://browscap.org/stream?q=%q';

    /**
     * The location to use to check out if a new version of the browscap.ini file is available.
     * @var string
     */
    private $remoteTimeUrl    = 'http://browscap.org/version';

    /**
     * @var string
     */
    private $remoteVersionUrl = 'http://browscap.org/version-number';

    /**
     * @var string
     */
    private $remoteFilename = self::PHP_INI;

    /**
     * sets the name of the local ini file
     *
     * @param string $name the file name
     *
     * @throws \BrowscapPHP\Helper\Exception
     * @return \BrowscapPHP\Helper\IniLoader
     */
    public function setRemoteFilename(string $name)
    {
        if (empty($name)) {
            throw new Exception(
                'the filename can not be empty',
                Exception::INI_FILE_MISSING
            );
        }

        $this->remoteFilename = $name;

        return $this;
    }

    /**
     * returns the of the remote location for updating the ini file
     *
     * @return string
     */
    public function getRemoteIniUrl() : string
    {
        return str_replace('%q', $this->remoteFilename, $this->remoteIniUrl);
    }

    /**
     * returns the of the remote location for checking the version of the ini file
     *
     * @return string
     */
    public function getRemoteTimeUrl() : string
    {
        return $this->remoteTimeUrl;
    }

    /**
     * returns the of the remote location for checking the version of the ini file
     *
     * @return string
     */
    public function getRemoteVersionUrl() : string
    {
        return $this->remoteVersionUrl;
    }
}