Skip to content

Latest commit

 

History

History
438 lines (320 loc) · 13.2 KB

fs.ru.md

File metadata and controls

438 lines (320 loc) · 13.2 KB

fs

  • класс fs (php\lib\fs)
  • пакет std
  • исходники php/lib/fs.php

Описание

File System class.

Class fs

Статичные Методы

  • fs ::separator() - Возвращает символ разделитель для имен файлов на текущей ОС.
  • fs ::pathSeparator() - Возвращает символ разделитель для файловых-путей на текущей ОС.
  • fs ::valid() - Проверяет имя файла на корректность.
  • fs ::abs() - Возвращает абсолютный путь.
  • fs ::name() - Возвращает имя файла пути.
  • fs ::nameNoExt() - Возвращает имя файла пути отсекая расшерение с точкой.
  • fs ::pathNoExt() - Возвращает путь отсекая расшерение с точкой.
  • fs ::relativize()
  • fs ::ext() - Возвращает расширение пути или файла без точки.
  • fs ::hasExt() - Check that $path has an extension from the extension set.
  • fs ::parent() - Возвращает родительскую директорию.
  • fs ::ensureParent() - Проверяет - есть ли родительские директории для пути и пытается их создать если их нет.
  • fs ::normalize() - Приводит файловый путь к родному виду текущей ОС.
  • fs ::exists() - Проверяет, существует ли файл.
  • fs ::size() - Возвращает размер файла в байтах.
  • fs ::isFile() - Проверяет, является ли указанный путь файлом.
  • fs ::isDir() - Проверяет, является ли указанный путь папкой.
  • fs ::isHidden() - Проверяет, является ли указанный путь скрытым системой.
  • fs ::time() - Возвращает последнее время модификации пути в unix timestamp (млсек).
  • fs ::makeDir() - Создает папку по указаному пути если их еще нет.
  • fs ::makeFile() - Создает пустой файл, если файл уже существует, перезаписывает его.
  • fs ::delete() - Удаляет файл или папку (с очисткой).
  • fs ::clean() - Удаляет все файлы найденные по указанному пути. Метод не удаляет саму указанную директорию.
  • fs ::scan() - Сканирует директорию с коллбэком или фильтром, и может возвращать список найденного, если
  • fs ::crc32() - Возвращает crc32 сумму файла или потока (stream), null если неудача!
  • fs ::hash() - Возвращает хеш файла или потока (stream), по-умолчанию MD5.
  • fs ::copy() - Копирует из одного файла/потока(stream) в другой файл/поток.
  • fs ::move() - Переименновывает или перемещает файл, либо пустую папку.
  • fs ::rename() - Задает файлу новое название, возвращает true при успехе.
  • fs ::get() - Возвращает данные полученные из потока или файла в виде бинарной строки.
  • fs ::parseAs() - Читает данные в переданном формате из источника и возвращает результат.
  • fs ::parse() - Читает данные в формате на основе расширения пути из источника и возвращает результат.
  • fs ::formatAs() - Записывает данные в нужном формате.
  • fs ::format() - Записывает данные в нужном формате на основе расширения.
  • fs ::match() - Tells if given path matches this matcher's pattern.

Статичные Методы

separator()

fs::separator(): string

Возвращает символ разделитель для имен файлов на текущей ОС.

pathSeparator()

fs::pathSeparator(): string

Возвращает символ разделитель для файловых-путей на текущей ОС.

valid()

fs::valid(mixed $name): bool

Проверяет имя файла на корректность.

abs()

fs::abs(mixed $path): string

Возвращает абсолютный путь.

name()

fs::name(mixed $path): string

Возвращает имя файла пути.

nameNoExt()

fs::nameNoExt(mixed $path): string

Возвращает имя файла пути отсекая расшерение с точкой.

pathNoExt()

fs::pathNoExt(string $path): string

Возвращает путь отсекая расшерение с точкой.

relativize()

fs::relativize(string $path, string $basePath): string

ext()

fs::ext(mixed $path): string

Возвращает расширение пути или файла без точки.

hasExt()

fs::hasExt(string $path, string|array $extensions, bool $ignoreCase): bool

Check that $path has an extension from the extension set.

parent()

fs::parent(mixed $path): string

Возвращает родительскую директорию.

ensureParent()

fs::ensureParent(string $path): bool

Проверяет - есть ли родительские директории для пути и пытается их создать если их нет. См. также: makeDir().

normalize()

fs::normalize(mixed $path): string

Приводит файловый путь к родному виду текущей ОС.

exists()

fs::exists(mixed $path): string

Проверяет, существует ли файл.

size()

fs::size(mixed $path): int

Возвращает размер файла в байтах.

isFile()

fs::isFile(mixed $path): bool

Проверяет, является ли указанный путь файлом.

isDir()

fs::isDir(mixed $path): bool

Проверяет, является ли указанный путь папкой.

isHidden()

fs::isHidden(mixed $path): bool

Проверяет, является ли указанный путь скрытым системой.

time()

fs::time(mixed $path): int

Возвращает последнее время модификации пути в unix timestamp (млсек).

makeDir()

fs::makeDir(string $path): bool

Создает папку по указаному пути если их еще нет.

makeFile()

fs::makeFile(mixed $path): bool

Создает пустой файл, если файл уже существует, перезаписывает его.

delete()

fs::delete(mixed $path): bool

Удаляет файл или папку (с очисткой).

clean()

fs::clean(string $path, callable|array $filter): array

Удаляет все файлы найденные по указанному пути. Метод не удаляет саму указанную директорию. Возвращает массив с ключами error, success и skip, в которых список файлов.

Фильтр может быть в виде массива: [ namePattern => string (regex), extensions => [...], excludeExtensions => [...], excludeDirs => bool, excludeFiles => bool, excludeHidden => bool,

minSize => int (мин. размер файла, включительно) maxSize => int (макс. размер файла, включительно), minTime => int, millis (мин. время изменения файла, включительно) maxTime => int, millis (макс. время изменения файла, включительно)

callback => function (File $file, $depth) { } ]

scan()

fs::scan(string $path, callable|array $filter, int $maxDepth, bool $subIsFirst): array

Сканирует директорию с коллбэком или фильтром, и может возвращать список найденного, если из коллбэка возвращать результат или если коллбэк не передан.

Фильтр в виде массива: [ namePattern => string (regex), extensions => [...], excludeExtensions => [...], excludeDirs => bool, excludeFiles => bool, excludeHidden => bool,

minSize => int (мин. размер файла, включительно) maxSize => int (макс. размер файла, включительно), minTime => int, millis (мин. время изменения файла, включительно) maxTime => int, millis (макс. время изменения файла, включительно)

callback => function (File $file, $depth) { } ]

crc32()

fs::crc32(string|Stream $source): int|null

Возвращает crc32 сумму файла или потока (stream), null если неудача!

hash()

fs::hash(string|Stream $source, string $algo, callable $onProgress): string|null

Возвращает хеш файла или потока (stream), по-умолчанию MD5.

copy()

fs::copy(string|File|Stream $source, string|File|Stream $dest, callable $onProgress, int $bufferSize): int

Копирует из одного файла/потока(stream) в другой файл/поток.

move()

fs::move(string $fromPath, string $toPath): bool

Переименновывает или перемещает файл, либо пустую папку.

rename()

fs::rename(string $pathToFile, string $newName): bool

Задает файлу новое название, возвращает true при успехе.

get()

fs::get(string $source, null|string $charset, string $mode): string

Возвращает данные полученные из потока или файла в виде бинарной строки.

parseAs()

fs::parseAs(mixed $path, string $format, int $flags): mixed

Читает данные в переданном формате из источника и возвращает результат.

parse()

fs::parse(mixed $path, int $flags): mixed

Читает данные в формате на основе расширения пути из источника и возвращает результат.

formatAs()

fs::formatAs(mixed $path, mixed $value, string $format, int $flags): void

Записывает данные в нужном формате.

format()

fs::format(mixed $path, mixed $value, int $flags): void

Записывает данные в нужном формате на основе расширения.

match()

fs::match(string $path, string $fsPattern): bool

Tells if given path matches this matcher's pattern.