PhpBotFramework\Entities\File

Complexity

Total Complexity

8

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

94.44%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	1
A	is_local()	0	12	3
A	getString()	0	4	1
A	getResource()	0	10	2
A	getFormatName()	0	4	1

<?php

/*
 * This file is part of the PhpBotFramework.
 *
 * PhpBotFramework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * PhpBotFramework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace PhpBotFramework\Entities;

use PhpBotFramework\Exceptions\BotException;

class File
{
    private $file;

    private $format_name;

    /**
     * \brief Fill this object with another file.
     * @param string $file File_id or local/remote path to the file.
     * @param string $format_name Format name of the file (audio, document, ...)
     */
    public function init(string $file, string $format_name)
    {
        $this->file = $file;
        $this->format_name = $format_name;
    }

    /**
     * \brief (<i>Internal</i>) Check if the path to the file given is local or a file_id/url.
     * @return bool True if the file is a local path.
     */
    public function is_local() : bool
    {
        $host = parse_url($this->file, PHP_URL_HOST);

        // If it has not an url host and it is a file_id
        if ($host === null && !is_numeric($this->file)) {
            // Then it is a local path
            return true;
        } else {
            return false;
        }
    }

    /**
     * \brief (<i>Internal</i>) Get string component of this file.
     * @return string File as string (file_id/path to the file).
     */
    public function getString()
    {
        return $this->file;
    }

    public function getResource()
    {
        $resource = fopen($this->file, 'r');

        if ($resource !== false) {
            return $resource;
        }

        return false;
    }

    public function getFormatName() : string
    {
        return $this->format_name;
    }
}