Класс Файл

__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

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

Возвращает

boolean
Успех

clearStatCache()source public

clearStatCache( boolean $all = false )

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

Параметры

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

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

close()source public

close( )

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

Возвращает

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

copy()source public

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

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

Параметры

строка $dest

Полный путь для копирования файла.

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

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

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

логическое значение
Успех

create()source public

create( )

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

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

логическое значение
Успех

delete()source public

delete( )

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

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

логическое значение
Успех

executable()source public

executable( )

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

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

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

exists()source public

exists( )

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

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

логическое значение
True, если существует, иначе false

ext()source public

ext( )

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

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

строка|false
Расширение файла, false если расширение не может быть извлечено.

folder()source public

folder( )

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

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

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

group()source public

group( )

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

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

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

info()source public

info( )

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

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

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

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

lastAccess()source public

lastAccess( )

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

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

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

lastChange()source public

lastChange( )

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

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

целое число|false
Отметка времени последней модификации или false в случае ошибки

md5()source public

md5( integer|boolean $maxsize = 5 )

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

Параметры

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

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

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

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

mime()source public

mime( )

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

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

false|строка
Тип MIME файла или false при неудаче чтения.

name()source public

name( )

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

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

строка|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, определяющая, относительно чего задается смещение $offset

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

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

open()source public

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

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

Параметры

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

Действительная строка режима 'fopen' (r|w|a ...)

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

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

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

логическое значение
True при успехе, false при неудаче

owner()source public

owner( )

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

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

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

perms()source public

perms( )

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

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

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

prepare()source public static

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

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

Параметры

строка $data

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

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

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

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

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

pwd()source public

pwd( )

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

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

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

read()source public

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

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

Параметры

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

с чего начать

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

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

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

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

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

строка|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
Успех

[]