Helldar\Support\Helpers\Filesystem\File

Complexity

Total Complexity

17

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Test Coverage

Coverage

94.29%

Importance

Changes	5
Bugs	5	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	4	2
A	isFile()	0	7	2
A	names()	0	18	5
A	store()	0	5	1
A	exists()	0	3	2
A	delete()	0	17	4
A	validated()	0	5	1

<?php

namespace Helldar\Support\Helpers\Filesystem;

use DirectoryIterator;
use Helldar\Support\Exceptions\FileNotFoundException;
use Helldar\Support\Facades\Helpers\Arr;
use Helldar\Support\Facades\Helpers\Filesystem\Directory as DirectoryHelper;
use Helldar\Support\Facades\Helpers\Instance;
use SplFileInfo;
use Throwable;

class File
{
    /**
     * Get a list of filenames along a path.
     *
     * @param  string  $path
     * @param  callable|null  $callback
     *
     * @return array
     */
    public function names(string $path, callable $callback = null): array
    {
        $items = [];

        /** @var \DirectoryIterator $item */
        foreach (DirectoryHelper::all($path) as $item) {
            if ($item->isFile()) {
                $name = $item->getFilename();

                if (! is_callable($callback) || $callback($name)) {
                    $items[] = $item->getFilename();
                }
            }
        }

        sort($items);

        return array_values($items);
    }

    /**
     * Save content to file.
     *
     * @param  string  $path
     * @param  string  $content
     * @param  int  $mode
     */
    public function store(string $path, string $content, int $mode = 0755): void
    {
        DirectoryHelper::make(pathinfo($path, PATHINFO_DIRNAME), $mode);

It seems like pathinfo($path, Helldar\Support\Helpers\Filesystem\PATHINFO_DIRNAME) can also be of type array; however, parameter $path of Helldar\Support\Facades\Helpers\Filesystem\Directory::make() does only seem to accept string, maybe add an additional type check?

        file_put_contents($path, $content);
    }

    /**
     * Checks if the file exists.
     *
     * @param  string  $path
     *
     * @return bool
     */
    public function exists(string $path): bool
    {
        return file_exists($path) && is_file($path);
    }

    /**
     * Deletes files in the specified paths.
     *
     * @param  string|string[]  $paths
     *
     * @return bool
     */
    public function delete($paths): bool
    {
        $paths = Arr::wrap($paths);

        $success = true;

        foreach ($paths as $path) {
            try {
                if (! @unlink($path)) {
                    $success = false;
                }
            } catch (Throwable $e) {
                $success = false;
            }
        }

        return $success;
    }

    /**
     * Checks if an object or link is a file at the specified path.
     *
     * @param  \DirectoryIterator|\SplFileInfo|string  $value
     *
     * @return bool
     */
    public function isFile($value): bool
    {
        if (Instance::of($value, [SplFileInfo::class, DirectoryIterator::class])) {
            return $value->isFile();
        }

        return is_file($value);
    }

    /**
     * Checks the existence of a file.
     *
     * @param  \DirectoryIterator|\SplFileInfo|string  $path
     *
     * @throws \Helldar\Support\Exceptions\FileNotFoundException
     */
    public function validate($path): void
    {
        if (! $this->isFile($path)) {
            throw new FileNotFoundException($path);
        }
    }

    /**
     * Checks the existence of a file and return full path if exist.
     *
     * @param  \DirectoryIterator|\SplFileInfo|string  $path
     *
     * @throws \Helldar\Support\Exceptions\FileNotFoundException
     *
     * @return string
     */
    public function validated($path): string
    {
        $this->validate($path);

        return realpath($path);
    }
}