Класс Файл

__construct()source public

__construct( string $path , boolean $create = false , integer $mode = 0755 )

Конструктор

Параметры

строка $path

Путь к файлу

логическое $create необязательно false

Создать файл, если он не существует (если true)

целое число $mode необязательно 0755

Режим для применения к папке, содержащей файл

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/file-folder.html#file-api

__destruct()source public

__destruct( )

Закрывает текущий файл, если он открыт

_basename()source protected static

_basename( string $path , string|null $ext = null )

Возвращает имя файла без пути. Имитирует php basename() для многобайтовых строк (mb_basename).

Параметры

строка $path

Путь к файлу

строка|null $ext необязательно null

Имя расширения

Возвращает

строка
имя файла без пути.

append()source public

append( string $data , boolean $force = false )

Добавляет строку данных в конец файла.

Параметры

строка $data

Данные для записи

логическое $force необязательно false

Принудительно открыть файл

Возвращает

логическое
Успех

clearStatCache()source public

clearStatCache( boolean $all = false )

Очищает внутренний кэш PHP stat

Параметры

логическое $all необязательно false

Очистить весь кэш или только для текущего пути. Передача false очистит кэш stat только для текущего пути.

close()source public

close( )

Закрывает текущий файл, если он открыт.

Возвращает

логическое
true, если закрытие прошло успешно или файл уже был закрыт, иначе false

copy()source public

copy( string $dest , boolean $overwrite = true )

Скопировать файл в $dest

Параметры

строка $dest

Абсолютный путь для копирования файла.

логическое значение $overwrite необязательно true

Перезаписать $dest, если он существует

Возвращаемое значение

boolean
Успех

create()source public

create( )

Создаёт файл.

Возвращаемое значение

boolean
Успех

delete()source public

delete( )

Удаляет файл.

Возвращаемое значение

boolean
Успех

executable()source public

executable( )

Возвращает true, если файл исполняемый.

Возвращаемое значение

boolean
True, если исполняемый, иначе false

exists()source public

exists( )

Возвращает true, если файл существует.

Возвращаемое значение

boolean
True, если существует, иначе false

ext()source public

ext( )

Возвращает расширение файла.

Возвращаемое значение

string|false
Расширение файла, false, если расширение извлечь нельзя.

folder()source public

folder( )

Возвращает текущую папку.

Возвращаемое значение

Cake\Filesystem\Folder
Текущая папка

group()source public

group( )

Возвращает группу файла.

Возвращаемое значение

integer|false
Группа файла, или false в случае ошибки

info()source public

info( )

Возвращает информацию о файле в виде массива с следующими ключами:

• dirname
• basename
• extension
• filename
• filesize
• mime

Возвращаемое значение

array
Информация о файле.

lastAccess()source public

lastAccess( )

Возвращает время последнего доступа.

Возвращаемое значение

integer|false
Отметка времени последнего доступа, или false в случае ошибки

lastChange()source public

lastChange( )

Возвращает время последнего изменения.

Возвращаемое значение

integer|false
Отметка времени последнего изменения, или false в случае ошибки

md5()source public

md5( integer|boolean $maxsize = 5 )

Получить контрольную сумму md5 файла с предварительной проверкой размера

Параметры

целое число|логическое значение $maxsize необязательно 5

в МБ или true для принудительного выполнения

Возвращаемое значение

string|false
md5 контрольная сумма См. md5_file(), или false в случае ошибки

mime()source public

mime( )

Получает тип MIME файла. Использует расширение finfo, если оно доступно, иначе использует mime_content_type().

Возвращаемое значение

false|string
Тип MIME файла, или false, если чтение завершилось ошибкой.

name()source public

name( )

Возвращает имя файла без расширения.

Возвращаемое значение

string|false
Имя файла без расширения, false, если имя извлечь нельзя.

offset()source public

offset( integer|boolean $offset = false , integer $seek = SEEK_SET )

Устанавливает или получает смещение для открытого файла.

Параметры

целое число|логическое значение $offset необязательно false

Смещение в байтах. Если установлено в false, возвращается текущее смещение.

целое число $seek необязательно SEEK_SET

Константа PHP SEEK_SET | SEEK_CUR | SEEK_END, определяющая, относительно чего вычисляется смещение.

Возвращаемое значение

integer|boolean
True при успехе, false при ошибке (для установки), false при ошибке или смещение в случае успеха (для получения)

open()source public

open( string $mode = 'r' , boolean $force = false )

Открывает текущий файл с заданным режимом.

Параметры

строка $mode необязательно 'r'

Допустимая строка режима 'fopen' (r|w|a ...)

логическое значение $force необязательно false

Если true, файл будет повторно открыт, даже если он уже открыт, иначе нет.

Возвращаемое значение

boolean
True при успехе, false при ошибке

owner()source public

owner( )

Возвращает владельца файла.

Возвращаемое значение

integer|false
Владелец файла, или false в случае ошибки

perms()source public

perms( )

Возвращает разрешения файла (chmod).

Возвращаемое значение

string|false
Разрешения файла, или false в случае ошибки

prepare()source public static

prepare( string $data , boolean $forceWindows = false )

Подготавливает строку ASCII для записи. Преобразует символы конца строки в правильный терминатор для текущей платформы. Для Windows используется "\r\n", для всех остальных платформ — "\n".

Параметры

строка $data

Данные для подготовки к записи.

логическое значение $forceWindows необязательно false

Если true, принудительно используется Windows строка новой строки.

Возвращаемое значение

string
Строка с преобразованными символами конца строки.

pwd()source public

pwd( )

Возвращает полный путь к файлу.

Возвращаемое значение

string
Полный путь к файлу

read()source public

read( string|boolean $bytes = false , string $mode = 'rb' , boolean $force = false )

Возвращает содержимое файла в виде строки.

Параметры

строка|логическое значение $bytes необязательно false

с какого места начать

строка $mode необязательно 'rb'

Режим, совместимый с fread.

логическое значение $force необязательно false

Если true, файл будет повторно открыт, даже если он уже открыт, иначе нет.

Возвращаемое значение

string|false
Строка при успехе, false при ошибке

readable()source public

readable( )

Возвращает true, если файл читаемый.

Возвращаемое значение

boolean
True, если файл читаемый, иначе false

replaceText()source public

replaceText( string|array $search , string|array $replace )

Ищет заданный текст и заменяет его, если найден.

Параметры

string|array $search

Текст(ы) для поиска.

string|array $replace

Текст(ы) для замены.

Возвращает

boolean
Успех

safe()source public

safe( string|null $name = null , string|null $ext = null )

Делает имя файла безопасным для сохранения.

Параметры

string|null $name необязательно null

Имя файла, которое нужно сделать безопасным, если оно отличается от $this->name

string|null $ext необязательно null

Имя расширения, которое нужно сделать безопасным, если оно отличается от $this->ext

Возвращает

string
Расширение файла

size()source public

size( )

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

Возвращает

integer|false
Размер файла в байтах, или false в случае ошибки

writable()source public

writable( )

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

Возвращает

boolean
True, если доступен для записи, иначе false

write()source public

write( string $data , string $mode = 'w' , boolean $force = false )

Записывает данные в файл.

Параметры

string $data

Данные для записи в файл.

string $mode необязательно 'w'

Режим записи. См. fwrite().

boolean $force необязательно false

Принудительно открыть файл

Возвращает

boolean
Успех

[]