fab2s\YaEtl\Traits\FileHandlerTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Importance

Changes	4
Bugs	1	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	prependBom()	0	7	3
A	setEncoding()	0	5	1
A	releaseHandle()	0	9	2
A	getEncoding()	0	3	1
A	setUseBom()	0	5	1
A	initHandle()	0	14	5
A	__destruct()	0	3	1

<?php

/*
 * This file is part of YaEtl
 *     (c) Fabrice de Stefanis / https://github.com/fab2s/YaEtl
 * This source file is licensed under the MIT license which you will
 * find in the LICENSE file or at https://opensource.org/licenses/MIT
 */

namespace fab2s\YaEtl\Traits;

use fab2s\Bom\Bom;
use fab2s\YaEtl\YaEtlException;

/**
 * Trait FileHandlerTrait
 */
trait FileHandlerTrait
{
    /**
     * @var resource
     */
    protected $handle;

    /**
     * @var string
     */
    protected $encoding;

    /**
     * @var bool
     */
    protected $useBom;

    /**
     * make sure we do not hold un-necessary handles
     */
    public function __destruct()
    {
        $this->releaseHandle();
    }

    /**
     * @return string|null
     */
    public function getEncoding(): ?string
    {
        return $this->encoding;
    }

    /**
     * @param string $encoding
     *
     * @return static
     */
    public function setEncoding(string $encoding): self
    {
        $this->encoding = $encoding;

        return $this;
    }

    /**
     * @param bool $useBom
     *
     * @return static
     */
    public function setUseBom(bool $useBom): self
    {
        $this->useBom = $useBom;

        return $this;
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public function prependBom(string $string): string
    {
        if ($this->encoding && ($bom = Bom::getEncodingBom($this->encoding))) {
            return $bom . $string;
        }

        return $string;
    }

    /**
     * release handle
     *
     * @return static
     */
    public function releaseHandle(): self
    {
        if (is_resource($this->handle)) {
            fclose($this->handle);
        }

        $this->handle = null;

        return $this;
    }

    /**
     * @param resource|string $input
     * @param string          $mode
     *
     * @throws YaEtlException
     *
     * @return static
     */
    protected function initHandle($input, string $mode): self
    {
        if (is_resource($input)) {
            $this->handle = $input;
        } elseif (is_file($input)) {
            $this->handle = fopen($input, $mode) ?: null;
            if (!$this->handle) {
                throw new YaEtlException('Handle could not be opened in mode:' . $mode);
            }
        } else {
            throw new YaEtlException('$input is either not a resource or not a file');
        }

        return $this;
    }
}