Liip\ImagineBundle\File\FileTemp

Complexity

Total Complexity

19

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	__destruct()	0	4	1
A	create()	0	10	2
A	getName()	0	4	1
A	setName()	0	7	2
A	getRoot()	0	4	1
A	setRoot()	0	7	1
A	isAcquired()	0	4	1
A	acquire()	0	16	2
A	release()	0	14	3
A	doSetContents()	0	8	2
A	requireReleasedState()	0	6	2

<?php

/*
 * This file is part of the `liip/LiipImagineBundle` project.
 *
 * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

namespace Liip\ImagineBundle\File;

use Liip\ImagineBundle\Exception\File\FileOperationException;
use Liip\ImagineBundle\File\Lock\LockInvokable;
use Liip\ImagineBundle\Utility\Interpreter\Interpreter;

/**
 * @author Rob Frawley 2nd <rmf@src.run>
 */
final class FileTemp extends AbstractFilePath implements FilePathInterface
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $root;

    /**
     * @param string|null $name
     * @param string|null $root
     */
    public function __construct(string $name = null, string $root = null)
    {
        parent::__construct();

        $this->setName($name);
        $this->setRoot($root);
    }

    /**
     * Automatically release the temporary file.
     */
    public function __destruct()
    {
        $this->release();
    }

    /**
     * @param string|null $name
     * @param string|null $root
     * @param string|null $contents
     *
     * @return self
     */
    public static function create(string $name = null, string $root = null, string $contents = null): self
    {
        $temporary = new self($name, $root);

        if (null !== $contents) {
            $temporary->setContents($contents);
        }

        return $temporary;
    }

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

    /**
     * @param string|null $name
     *
     * @return self
     */
    public function setName(string $name = null): self
    {
        $this->requireReleasedState('failed to change context descriptor');
        $this->name = sprintf('imagine-bundle-temporary_%s', $name ?: 'general');

        return $this;
    }

    /**
     * @return string
     */
    public function getRoot(): string
    {
        return $this->root;
    }

    /**
     * @param string|null $path
     *
     * @return FileTemp
     */
    public function setRoot(string $path = null): self
    {
        $this->requireReleasedState('failed to change path prefix');
        $this->root = self::makePathIfNotExists($path ?? sys_get_temp_dir());

        return $this;
    }

    /**
     * @return bool
     */
    public function isAcquired(): bool
    {
        return $this->hasFile();
    }

    /**
     * @return self
     */
    public function acquire(): self
    {
        $this->requireReleasedState('failed to acquire a new one');

        $this->file = LockInvokable::blocking($this, function (): \SplFileInfo {
            if (false !== $file = @tempnam($this->getRoot(), $this->getName())) {
                return new \SplFileInfo($file);
            }

            throw new FileOperationException(
                'Failed to acquire temporary file in "%s": %s.', $this->getRoot(), Interpreter::error()->message()
            );
        });

        return $this;
    }

    /**
     * @param bool $remove
     *
     * @return self
     */
    public function release(bool $remove = true): self
    {
        if (!$this->isAcquired()) {
            return $this;
        }

        if ($remove) {
            $this->remove();
        }

        $this->file = null;

        return $this;
    }

    /**
     * @param string $contents
     * @param bool   $append
     */
    protected function doSetContents(string $contents, bool $append): void
    {
        if (!$this->isAcquired()) {
            $this->acquire();
        }

        parent::doSetContents($contents, $append);
    }

    /**
     * @param string $message
     */
    private function requireReleasedState(string $message): void
    {
        if ($this->isAcquired()) {
            throw new FileOperationException('Temporary file must be released first: %s', $message);
        }
    }
}