Класс Файл

__construct()source public

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

Конструктор

Параметры

строка $path

Путь к файлу

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

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

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

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

Ссылка

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

__destruct()source public

__destruct( )

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

append()source public

append( string $data , boolean $force false )

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

Параметры

строка $data

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

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

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

Возвращает

boolean
Успех

clearStatCache()source public

clearStatCache( boolean $all false )

Очистить внутренний кэш статистики PHP

Параметры

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

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

close()source public

close( )

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

Возвращает

boolean
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 файла с предварительной проверкой размера файла

Параметры

integer|boolean $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 )

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

Параметры

integer|boolean $offset необязательный false

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

integer $seek необязательный SEEK_SET

Постоянная PHP SEEK_SET | SEEK_CUR | SEEK_END, определяющая, относительно чего задаётся смещение $offset.

Возвращает

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

open()source public

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

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

Параметры

string $mode необязательный 'r'

Строка режима 'fopen' (r|w|a ...)

boolean $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".

Параметры

string $data

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

boolean $forceWindows необязательный false

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

Возвращает

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

pwd()source public

pwd( )

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

Возвращает

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

read()source public

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

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

Параметры

string|boolean $bytes необязательный false

с какой позиции начать

string $mode необязательный 'rb'

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

boolean $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
Успех

[]