Класс Файл

__constructsource public

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

Конструктор

Параметры

строка $path

Путь к файлу

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

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

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

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

Ссылка

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

__destructsource public

__destruct( )

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

appendsource public

append( string $data , boolean $force false )

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

Параметры

строка $data

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

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

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

Возвращает

boolean
Успех

clearStatCachesource public

clearStatCache( boolean $all false )

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

Параметры

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

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

closesource public

close( )

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

Возвращает

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

copysource public

copy( string $dest , boolean $overwrite true )

Копирует файл в $dest

Параметры

строка $dest

Место назначения для копии

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

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

Возвращает

boolean
Успех

createsource public

create( )

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

Возвращает

boolean
Успех

deletesource public

delete( )

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

Возвращает

boolean
Успех

executablesource public

executable( )

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

Возвращает

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

existssource public

exists( )

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

Возвращает

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

extsource public

ext( )

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

Возвращает

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

foldersource public

folder( )

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

Возвращает

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

groupsource public

group( )

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

Возвращает

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

infosource public

info( )

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

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

Возвращает

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

lastAccesssource public

lastAccess( )

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

Возвращает

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

lastChangesource public

lastChange( )

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

Возвращает

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

md5source public

md5( integer|boolean $maxsize 5 )

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

Параметры

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

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

Возвращает

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

mimesource public

mime( )

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

Возвращает

false|string
Тип MIME файла или false, если чтение не удалось.

namesource public

name( )

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

Возвращает

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

offsetsource public

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

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

Параметры

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

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

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

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

Возвращает

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

opensource public

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

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

Параметры

string $mode опционально 'r'

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

boolean $force опционально false

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

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

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

ownersource public

owner( )

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

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

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

permssource public

perms( )

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

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

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

preparesource public static

prepare( string $data , boolean $forceWindows false )

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

Параметры

string $data

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

boolean $forceWindows опционально false

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

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

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

pwdsource public

pwd( )

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

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

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

readsource 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 при ошибке

readablesource public

readable( )

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

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

boolean
True, если файл доступен для чтения, false в противном случае

replaceTextsource public

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

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

Параметры

string|array $search

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

string|array $replace

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

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

boolean
Успех

safesource public

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

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

Параметры

string|null $name опционально null

Имя файла для безопасного преобразования, если оно отличается от $this->name

string|null $ext опционально null

Имя расширения для безопасного преобразования, если оно отличается от $this->ext

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

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

sizesource public

size( )

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

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

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

writablesource public

writable( )

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

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

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

writesource public

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

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

Параметры

string $data

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

string $mode опционально 'w'

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

boolean $force опционально false

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

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

boolean
Успешно

null

null

[]

null

null

null