Класс Файл

__construct()source public

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

Конструктор

Параметры

string $path

Путь к файлу

boolean $create optional false

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

integer $mode optional 0755

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

Ссылка

http://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 )

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

Параметры

string $data

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

boolean $force optional false

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

Возвращает

boolean
Успех

clearStatCache()source public

clearStatCache( boolean $all false )

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

Параметры

boolean $all optional false

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

close()source public

close( )

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

Возвращает

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

copy()source public

copy( string $dest , boolean $overwrite true )

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

Параметры

string $dest

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

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

Возвращает

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

open()source public

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

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

Параметры

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

null

null

[]

null

null

null