File::exists() - Code Metrics - andrey-helldar/support - Measure and Improve Code Quality continuously with Scrutinizer

File::exists() A
last analyzed 2021-10-14 20:53 UTC

↳ Parent: File

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	1
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	2
rs	10

<?php
/*
 * This file is part of the "andrey-helldar/support" project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Andrey Helldar <[email protected]>
 *
 * @copyright 2021 Andrey Helldar
 *
 * @license MIT
 *
 * @see https://github.com/andrey-helldar/support
 */

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 Helldar\Support\Facades\Helpers\Str;
use SplFileInfo;
use Throwable;

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

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

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

            if ($recursive && $item->isDir() && ! $item->isDot()) {
                $prefix = (string) Str::of($item->getRealPath())
                    ->after(realpath($path))
                    ->trim('\\/');

                foreach ($this->names($item->getRealPath(), $callback, $recursive) as $value) {
                    $items[] = $prefix . '/' . $value;
                }
            }
        }

        sort($items);

        return array_values($items);
    }

    /**
     * Save content to file.
     *
     * @param  string  $path
     * @param  string  $content
     * @param  int  $mode
     *
     * @return string Returns the full path to the saved file.
     */
    public function store(string $path, string $content, int $mode = 0755): string
    {
        DirectoryHelper::ensureDirectory(pathinfo($path, PATHINFO_DIRNAME), $mode);
        DirectoryHelper::ensureDirectory(/** @scrutinizer ignore-type */ pathinfo($path, PATHINFO_DIRNAME), $mode);

        file_put_contents($path, $content);

        return realpath($path);
    }

    /**
     * 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;
    }

    /**
     * Ensure the file has been deleted.
     *
     * @param  array|string  $paths
     *
     * @return bool
     */
    public function ensureDelete($paths): bool
    {
        $paths = Arr::wrap($paths);

        $success = true;

        foreach ($paths as $path) {
            if ($this->exists($path) && ! $this->delete($path)) {
                $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);
    }
}


andrey-helldar / support

File::exists() A last analyzed 2021-10-14 20:53 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

File::exists() A
last analyzed 2021-10-14 20:53 UTC