Filesystem
class Filesystem
Предоставляет базовые инструменты для работы с файловой системой.
Methods
| copy(string $originFile, string $targetFile, bool $overwriteNewerFiles = false) Копирует файл. | ||
| mkdir(string|array|Traversable $dirs, int $mode = 511) Создаёт директорию рекурсивно. | ||
| bool | exists(string|array|Traversable $files) Проверяет существование файлов или директорий. | |
| touch(string|array|Traversable $files, int $time = null, int $atime = null) Устанавливает время доступа и изменения файла. | ||
| remove(string|array|Traversable $files) Удаляет файлы или директории. | ||
| chmod(string|array|Traversable $files, int $mode, int $umask, bool $recursive = false) Изменяет режим для массива файлов или директорий. | ||
| chown(string|array|Traversable $files, string $user, bool $recursive = false) Изменяет владельца массива файлов или директорий. | ||
| chgrp(string|array|Traversable $files, string $group, bool $recursive = false) Изменяет группу массива файлов или директорий. | ||
| rename(string $origin, string $target, bool $overwrite = false) Переименовывает файл или директорию. | ||
| symlink(string $originDir, string $targetDir, bool $copyOnWindows = false) Создаёт символическую ссылку или копирует директорию. | ||
| hardlink(string $originFile, string|string[] $targetFiles) Создаёт жёсткую ссылку, или несколько жёстких ссылок на файл. | ||
| string|null | readlink(string $path, bool $canonicalize = false) Разрешает ссылки в путях. | |
| string | makePathRelative(string $endPath, string $startPath) Преобразует существующий путь в относительный к заданному начальному пути. | |
| mirror(string $originDir, string $targetDir, Traversable $iterator = null, array $options = array()) Создаёт копию директории. | ||
| bool | isAbsolutePath(string $file) Возвращает, является ли путь к файлу абсолютным. | |
| string | tempnam(string $dir, string $prefix) Создаёт временный файл с поддержкой пользовательских оберток потоков. | |
| dumpFile(string $filename, string $content) Атомарно записывает содержимое в файл. |
Details
copy(string $originFile, string $targetFile, bool $overwriteNewerFiles = false)
Копирует файл.
Если целевой файл старше исходного файла, он всегда перезаписывается. Если целевой файл новее, он перезаписывается только в том случае, если параметр $overwriteNewerFiles имеет значение true.
Параметры
| string | $originFile | Исходное имя файла |
| string | $targetFile | Имя целевого файла |
| bool | $overwriteNewerFiles | Если true, целевые файлы, более новые, чем исходные, перезаписываются |
Исключения
| FileNotFoundException | Когда исходный файл не существует |
| IOException | При ошибке копирования |
mkdir(string|array|Traversable $dirs, int $mode = 511)
Создает директорию рекурсивно.
Параметры
| string|array|Traversable | $dirs | Путь к директории |
| int | $mode | Режим директории |
Исключения
| IOException | При любой ошибке создания директории |
bool exists(string|array|Traversable $files)
Проверяет существование файлов или директорий.
Параметры
| string|array|Traversable | $files | Имя файла, массив файлов или объект \Traversable для проверки |
Возвращаемое значение
| bool | true, если файл существует, в противном случае false |
touch(string|array|Traversable $files, int $time = null, int $atime = null)
Устанавливает время доступа и изменения файла.
Параметры
| string|array|Traversable | $files | Имя файла, массив файлов или объект \Traversable для создания |
| int | $time | Время изменения как Unix-таймштамп |
| int | $atime | Время доступа как Unix-таймштамп |
Исключения
| IOException | При ошибке touch |
remove(string|array|Traversable $files)
Удаляет файлы или директории.
Параметры
| string|array|Traversable | $files | Имя файла, массив файлов или объект \Traversable для удаления |
Исключения
| IOException | При ошибке удаления |
chmod(string|array|Traversable $files, int $mode, int $umask, bool $recursive = false)
Изменение режима для массива файлов или директорий.
Параметры
| string|array|Traversable | $files | Имя файла, массив файлов или объект \Traversable для изменения режима |
| int | $mode | Новый режим (восьмеричный) |
| int | $umask | Маска режима (восьмеричный) |
| bool | $recursive | Изменять режим рекурсивно или нет |
Исключения
| IOException | При ошибке изменения |
chown(string|array|Traversable $files, string $user, bool $recursive = false)
Изменение владельца массива файлов или директорий.
Параметры
| string|array|Traversable | $files | Имя файла, массив файлов или объект \Traversable для изменения владельца |
| string | $user | Имя нового владельца |
| bool | $recursive | Изменять владельца рекурсивно или нет |
Исключения
| IOException | При ошибке изменения |
chgrp(string|array|Traversable $files, string $group, bool $recursive = false)
Изменение группы массива файлов или директорий.
Параметры
| string|array|Traversable | $files | Имя файла, массив файлов или объект \Traversable для изменения группы |
| string | $group | Имя группы |
| bool | $recursive | Изменять группу рекурсивно или нет |
Исключения
| IOException | При ошибке изменения |
rename(string $origin, string $target, bool $overwrite = false)
Переименовывает файл или директорию.
Параметры
| string | $origin | Исходное имя файла или директории |
| string | $target | Новое имя файла или директории |
| bool | $overwrite | Перезаписать целевой файл, если он уже существует |
Исключения
| IOException | Когда целевой файл или директория уже существуют |
| IOException | Когда исходный файл не может быть переименован |
symlink(string $originDir, string $targetDir, bool $copyOnWindows = false)
Создаёт символическую ссылку или копирует директорию.
Параметры
| string | $originDir | Путь к исходной директории |
| string | $targetDir | Имя символической ссылки |
| bool | $copyOnWindows | Копировать файлы вместо ссылок, если на Windows |
Исключения
| IOException | При ошибке создания символической ссылки |
hardlink(string $originFile, string|string[] $targetFiles)
Создаёт жёсткую ссылку или несколько жёстких ссылок на файл.
Параметры
| string | $originFile | Исходный файл |
| string|string[] | $targetFiles | Целевой файл(ы) |
Исключения
| FileNotFoundException | Когда исходный файл отсутствует или не является файлом |
| IOException | При ошибке создания ссылки, включая случай, когда ссылка уже существует |
string|null readlink(string $path, bool $canonicalize = false)
Разрешает ссылки в путях.
При $canonicalize = false (по умолчанию) - если $path не существует или не является ссылкой, возвращает null - если $path является ссылкой, возвращает следующий непосредственный целевой путь без учёта существования целевого пути
При $canonicalize = true - если $path не существует, возвращает null - если $path существует, возвращает его абсолютный, полностью разрешённый конечный путь
Параметры
| string | $path | Путь к файловой системе |
| bool | $canonicalize | Возвращать канонизированный путь или нет |
Возвращаемое значение
| string|null |
string makePathRelative(string $endPath, string $startPath)
Преобразует существующий путь в относительный путь к заданному начальному пути.
Параметры
| string | $endPath | Абсолютный путь цели |
| string | $startPath | Абсолютный путь, с которого начинается перемещение |
Возвращаемое значение
| string | Относительный путь к цели относительно начального пути |
mirror(string $originDir, string $targetDir, Traversable $iterator = null, array $options = array())
Создаёт зеркальное отображение директории в другой директории.
Параметры
| string | $originDir | Исходная директория |
| string | $targetDir | Целевая директория |
| Traversable | $iterator | Объект Traversable |
| array | $options | Массив опций (булевых). Допустимые опции: - $options['override'] Перезаписывать ли существующий файл при копировании (см. copy()) - $options['copyonwindows'] Копировать файлы вместо создания ссылок на Windows (см. symlink()) - $options['delete'] Удалять ли файлы, отсутствующие в исходной директории (по умолчанию false) |
Исключения
| IOException | При неизвестном типе файла |
bool isAbsolutePath(string $file)
Возвращает, является ли путь к файлу абсолютным.
Параметры
| string | $file | Путь к файлу |
Возвращаемое значение
| bool |
string tempnam(string $dir, string $prefix)
Создает временный файл с поддержкой пользовательских обработчиков потоков.
Параметры
| string | $dir | Директория, в которой будет создан временный файл |
| string | $prefix | Префикс сгенерированного временного имени файла. Примечание: Windows использует только первые три символа префикса. |
Возвращаемое значение
| string | Новое временное имя файла (с путем) или исключение при ошибке |
dumpFile(string $filename, string $content)
Атомарно сохраняет содержимое в файл.
Параметры
| string | $filename | Файл, в который будет записано содержимое |
| string | $content | Данные для записи в файл |
Исключения
| IOException | Если файл нельзя записать. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Filesystem/Filesystem.html