FileHandlerTrait::releaseHandle() - Code Metrics - fab2s/YaEtl - Measure and Improve Code Quality continuously with Scrutinizer

FileHandlerTrait::releaseHandle() A
last analyzed 2023-01-04 08:06 UTC

↳ Parent: FileHandlerTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	9
rs	10

<?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;
    }
}


1			<?php
2
3			/*
4			* This file is part of YaEtl
5			* (c) Fabrice de Stefanis / https://github.com/fab2s/YaEtl
6			* This source file is licensed under the MIT license which you will
7			* find in the LICENSE file or at https://opensource.org/licenses/MIT
8			*/
9
10			namespace fab2s\YaEtl\Traits;
11
12			use fab2s\Bom\Bom;
13			use fab2s\YaEtl\YaEtlException;
14
15			/**
16			* Trait FileHandlerTrait
17			*/
18			trait FileHandlerTrait
19			{
20			/**
21			* @var resource
22			*/
23			protected $handle;
24
25			/**
26			* @var string
27			*/
28			protected $encoding;
29
30			/**
31			* @var bool
32			*/
33			protected $useBom;
34
35			/**
36			* make sure we do not hold un-necessary handles
37			*/
38			public function __destruct()
39			{
40			$this->releaseHandle();
41			}
42
43			/**
44			* @return string\|null
45			*/
46			public function getEncoding(): ?string
47			{
48			return $this->encoding;
49			}
50
51			/**
52			* @param string $encoding
53			*
54			* @return static
55			*/
56			public function setEncoding(string $encoding): self
57			{
58			$this->encoding = $encoding;
59
60			return $this;
61			}
62
63			/**
64			* @param bool $useBom
65			*
66			* @return static
67			*/
68			public function setUseBom(bool $useBom): self
69			{
70			$this->useBom = $useBom;
71
72			return $this;
73			}
74
75			/**
76			* @param string $string
77			*
78			* @return string
79			*/
80			public function prependBom(string $string): string
81			{
82			if ($this->encoding && ($bom = Bom::getEncodingBom($this->encoding))) {
83			return $bom . $string;
84			}
85
86			return $string;
87			}
88
89			/**
90			* release handle
91			*
92			* @return static
93			*/
94			public function releaseHandle(): self
95			{
96			if (is_resource($this->handle)) {
97			fclose($this->handle);
98			}
99
100			$this->handle = null;
101
102			return $this;
103			}
104
105			/**
106			* @param resource\|string $input
107			* @param string $mode
108			*
109			* @throws YaEtlException
110			*
111			* @return static
112			*/
113			protected function initHandle($input, string $mode): self
114			{
115			if (is_resource($input)) {
116			$this->handle = $input;
117			} elseif (is_file($input)) {
118			$this->handle = fopen($input, $mode) ?: null;
119			if (!$this->handle) {
120			throw new YaEtlException('Handle could not be opened in mode:' . $mode);
121			}
122			} else {
123			throw new YaEtlException('$input is either not a resource or not a file');
124			}
125
126			return $this;
127			}
128			}
129

fab2s / YaEtl

FileHandlerTrait::releaseHandle() A last analyzed 2023-01-04 08:06 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FileHandlerTrait::releaseHandle() A
last analyzed 2023-01-04 08:06 UTC