Menu

ru.core.files

azex

>>> Содержание <<<

Модуль files.php

Общее описание

Содержит класс Files, предназначенный для выполнения операций копирования, перемещения и удаления. Возможно выполнение действий, как с отдельными файлами и символическими ссылками, так и с директориями (далее обобщенно объект), содержащими множество файлов, символьных ссылок и поддиректорий.

Методы класса Files

int errId()

Описание
Возвращает код последней возникшей ошибки.

Возвращаемые значения
Число, соответствующее константам вида ERROR_*. Значение 0 означает отсутствие ошибки.


string errExp()

Описание
Возвращает описание последней возникшей ошибки.

Возвращаемые значения
Строка с описанием ошибки. Пустая строка означает отсутствие ошибки.


bool copy(string $sourcePath, string $destPath, bool $mergeDirs = FALSE, bool $rewriteFiles = FALSE, bool $skipExistentFiles = FALSE, bool $skipNotReadable = FALSE, bool $skipWriteProtected = FALSE, bool $skipConflicts = FALSE, bool $removeConflictFiles = FALSE)

Описание
Производит копирование исходного объекта в указаное место.

Принимаемые значения
sourcePath - путь к исходному объекту.
destPath - путь к объекту назначения.
mergeDirs - флаг сливания директорий. Принимает значения TRUE, или FALSE.
rewriteFiles - флаг перезаписи файлов при сливании. Принимает значения TRUE, или FALSE.
skipExistentFiles - флаг пропуска существующих файлов при сливании. Принимает значения TRUE, или FALSE. В случае перезаписи файла, этот аргумент игнонорируется.
skipNotReadable - флаг пропуска нечитаемых файлов и директорий при сливании. Принимает значения TRUE, или FALSE.
skipWriteProtected - флаг пропуска защищённых от записи файлов и директорий при сливании. Принимает значения TRUE, или FALSE.
skipConflicts - флаг пропуска конфликтов при сливании. К конфликтам относятся попытки замены существующего файла, или символической ссылки, указывающей на файл, директорией; и попытки замены существующей директории файлом или символической ссылкой. Принимает значения TRUE, или FALSE.
removeConflictFiles - флаг удаления файлов и директорий при конфликтах. Позволяет удалять директории, которые нужно заменить файлами; и удалять файлы, которые нужно заменить директориями. Принимает значения TRUE, или FALSE.

Возвращаемые значения
В случае успеха возвращает TRUE, иначе FALSE.


bool move(string $sourcePath, string $destPath, bool $mergeDirs = FALSE, bool $replaceFiles = FALSE, bool $skipExistentFiles = FALSE, bool $skipNotReadable = FALSE, bool $skipWriteProtected = FALSE, bool $skipConflicts = FALSE, bool $removeConflictFiles = FALSE)

Описание
Производит перемещение исходного объекта в указанное место.

Принимаемые значения
sourcePath - путь к исходному объекту.
destPath - путь к объекту назначения.
mergeDirs - флаг сливания директорий. Принимает значения TRUE, или FALSE.
replaceFiles - флаг замены файлов при сливании. Принимает значения TRUE, или FALSE.
skipExistentFiles - флаг пропуска существующих файлов при сливании. Принимает значения TRUE, или FALSE. В случае замены файла, этот аргумент игнонорируется.
skipNotReadable - флаг пропуска нечитаемых директорий при сливании. Принимает значения TRUE, или FALSE.
skipWriteProtected - флаг пропуска защищённых от записи директорий при сливании. Принимает значения TRUE, или FALSE.
skipConflicts - флаг пропуска конфликтов при сливании. К конфликтам относятся попытки замены существующего файла, или символической ссылки, указывающей на файл, директорией; попытки замены существующей директории файлом или символической ссылкой; и попытки удаления директории, не являющехся пустыми. Принимает значения TRUE, или FALSE.
removeConflictFiles - флаг удаления файлов и директорий при конфликтах. Позволяет удалять директории, которые нужно заменить файлами; и удалять файлы, которые нужно заменить директориями. Принимает значения TRUE, или FALSE.

Возвращаемые значения
В случае успеха возвращает TRUE, иначе FALSE.


bool remove(string $sourcePath, bool $skipNotReadable = FALSE, bool $skipWriteProtected = FALSE, bool $skipConflicts = FALSE)

Описание
Удаляет указанный объект.

Принимаемые значения
sourcePath - путь к удаляемому объекту.
skipNotReadable - флаг пропуска нечитаемых директорий. Принимает значения TRUE, или FALSE.
skipWriteProtected - флаг пропуска защищённых от записи директорий. Принимает значения TRUE, или FALSE.
skipConflicts - флаг пропуска конфликтов. К конфликтам относятся попытки удаления директорий, не являющехся пустыми. Принимает значения TRUE, или FALSE.

Возвращаемые значения
В случае успеха возвращает TRUE, иначе FALSE.

>>> Содержание <<<


Related

Wiki: ru.index