Simondubois\UnsplashDownloader\History

Complexity

Total Complexity

13

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getPath()	0	4	1
A	getContent()	0	4	1
A	load()	0	13	3
A	save()	0	7	2
A	has()	0	4	2
A	put()	0	4	1
A	loadContent()	0	11	2
A	saveContent()	0	6	1

<?php namespace Simondubois\UnsplashDownloader;

use Exception;

/**
 * A proxy to handle history operations like :
 * - loading history from file
 * - checking existence of a entity in history
 * - appending data to history
 * - saving history to file
 */
class History
{

    //
    // Attributes
    //

    /**
     * Has a file content been loaded
     * @var bool
     */
    private $loaded = false;

    /**
     * Path of the file to use for history
     * @var string
     */
    private $path;

    /**
     * History content
     * @var array
     */
    private $content = [];



    //
    // Getters
    //

    /**
     * Get path attribute
     * @return string Path to file
     */
    public function getPath()
    {
        return $this->path;
    }


    /**
     * Get content attribute
     * @return array Content data
     */
    public function getContent()
    {
        return $this->content;
    }



    //
    // File handling
    //

    /**
     * Read and parse file content
     * @param  string|null $path Path to file
     * @return bool True if the file has been successfully loaded
     */
    public function load($path) {
        if ($this->loaded) {
            throw new Exception('The file '.$this->path.' has already been loaded into history');
        }

        $this->path = $path;

        if ($this->loadContent()) {
            $this->loaded = true;
        }

        return $this->loaded;
    }

    /**
     * Save content to file
     * @return bool True if the file has been successfully saved
     */
    public function save() {
        if ($this->loaded === false) {
            return false;
        }

        return $this->saveContent();
    }



    //
    // Content handling
    //

    /**
     * Check if a string is in history
     * @param  string  $str String to look for
     * @return bool True if the string has been found in history
     */
    public function has($str)
    {
        return $this->loaded && in_array($str, $this->content);
    }

    /**
     * Append a string to the history
     * @param  string $str String to add to history
     */
    public function put($str)
    {
        $this->content[] = $str;
    }

    /**
     * Load file content into content attribute
     * @return bool True if the file has been successfully loaded
     */
    private function loadContent() {
        $content = @file($this->path, FILE_IGNORE_NEW_LINES);

        if ($content === false) {
            return false;
        }

        $this->content = $content;

        return true;
    }

    /**
     * Save content attribute into file
     * @return bool True if the file has been successfully saved
     */
    private function saveContent() {
        $content = implode(PHP_EOL, $this->content);
        $writtenBytes = file_put_contents($this->path, $content);

        return is_int($writtenBytes);
    }

}