Documentation

Dir
in package

Класс Dir

Tags
version
0.0.1
generated

Зорин Алексей, please DO NOT EDIT!

author

Зорин Алексей zorinalexey59292@gmail.com

copyright

2022 разработчик Зорин Алексей Евгеньевич.

Table of Contents

create()  : bool
Создать дирректорию
delete()  : bool
Удалить дирректорию рекурсивно
has()  : bool
Проверка наличия дирректории
info()  : File
Получить подробную информацию о директории
permissions()  : bool
Установить права на дирректорию
scan()  : array<string|int, mixed>
Сканировать дирректорию
recursiveRemove()  : void
Рекурсивное удаление дирректории вместе содержимым

Methods

create()

Создать дирректорию

public static create([string|null $dir = null ][, string $permissions = 0777 ][, bool $recursive = true ]) : bool
Parameters
$dir : string|null = null

Путь дирректории которую необходимо создать

$permissions : string = 0777

Права на дирректорию

$recursive : bool = true

Создать рекурсивно

Return values
bool

В случае успеха вернет true, иначе false

delete()

Удалить дирректорию рекурсивно

public static delete(string|null $dir[, bool $recursive = false ]) : bool
Parameters
$dir : string|null

Путь к дирректории

$recursive : bool = false

Удалить дирректорию рекурсивно

Return values
bool

В случае успеха вернет true, иначе false

has()

Проверка наличия дирректории

public static has([string|null $dir = null ]) : bool
Parameters
$dir : string|null = null

Путь до дирректории

Return values
bool

Если дирректория найдена, то вернет true, иначе false

info()

Получить подробную информацию о директории

public static info(string $dir) : File
Parameters
$dir : string

Путь к дирректории

Return values
File

Объект класса File заполненый информацией об указаной директории

permissions()

Установить права на дирректорию

public static permissions(string $dir[, string $permissions = 0777 ]) : bool
Parameters
$dir : string

Путь к дирректории

$permissions : string = 0777

Необходимые права

Return values
bool

В случае успеха вернет true, иначе false

scan()

Сканировать дирректорию

public static scan(string $dir) : array<string|int, mixed>
Parameters
$dir : string

Путь к дирректории

Return values
array<string|int, mixed>

Массив с файлами и каталогами директории

recursiveRemove()

Рекурсивное удаление дирректории вместе содержимым

private static recursiveRemove(string $dir) : void
Parameters
$dir : string

Путь к дирректории

Return values
void

Search results