Класс файла
Удобный класс для чтения, записи и добавления в файлы.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Utility/File.php
Резюме свойств
- Объект папки файла
$Folderpublic -
$handlepublicСодержит ресурс обработчика файла, если файл открытresource -
$infopublicИнформация о файлеarray -
$lockpublicВключить блокировку для чтения и записи файлаboolean -
$namepublicИмя файлаstring -
$pathpublicСвойство путиmixed
Резюме методов
- __construct() publicКонструктор
- __destruct() publicЗакрывает текущий файл, если он открыт
- append() publicДобавить заданную строку данных в этот файл.
- clearStatCache() publicОчистить внутренний кэш stat PHP
- close() publicЗакрывает текущий файл, если он открыт.
- copy() publicСкопировать файл в $dest
- create() publicСоздает файл.
- delete() publicУдаляет файл.
- executable() publicВозвращает true, если файл исполняемый.
- exists() publicВозвращает true, если файл существует.
- ext() publicВозвращает расширение файла.
- folder() publicВозвращает текущую папку.
- group() publicВозвращает группу файла.
- info() publicВозвращает информацию о файле в виде массива с следующими ключами:
- lastAccess() publicВозвращает время последнего доступа.
- lastChange() publicВозвращает время последнего изменения.
- md5() publicПолучить контрольную сумму md5 файла с предварительной проверкой размера файла
- mime() public
Получить тип MIME файла. Использует расширение finfo, если оно доступно, в противном случае использует mime_content_type
- name() publicВозвращает имя файла без расширения.
- offset() publicУстанавливает или получает смещение для текущего открытого файла.
- open() publicОткрывает текущий файл с заданным режимом $mode
- owner() publicВозвращает владельца файла.
- perms() publicВозвращает разрешения "chmod" файла.
-
Подготавливает строку ASCII для записи. Преобразует окончания строк в правильный терминатор для текущей платформы. Если Windows, будет использоваться «\r\n», на всех остальных платформах будет использоваться «\n»
- pwd() publicВозвращает полный путь к файлу.
- read() publicВозвращает содержимое этого файла в виде строки.
- readable() publicВозвращает true, если файл читаем.
- replaceText() publicИщет заданный текст и заменяет его, если он найден.
- safe() publicДелает имя файла безопасным для сохранения
- size() publicВозвращает размер файла
- writable() publicВозвращает true, если файл можно записать.
- write() publicЗаписать заданные данные в этот файл.
Подробное описание метода
__construct()source public
__construct( string $path , boolean $create false , integer $mode 0755 )
Конструктор
Параметры
- string
$path - Путь к файлу
- boolean
$createнеобязательно false - Создать файл, если он не существует (если true)
- integer
$modeнеобязательно 0755 - Режим, применяемый к папке, содержащей файл
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Fileappend()source public
append( string $data , string $force false )
Добавить заданную строку данных в этот файл.
Параметры
- string
$data - Данные для записи
- string
$forceнеобязательно false - Принудительно открыть файл
Возвращает
booleanУспех
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::appendclearStatCache()source public
clearStatCache( boolean $all false )
Очистить внутренний кэш stat PHP
Для версий 5.3 и выше можно очистить кэш только для одного файла. Передача true очистит весь кэш stat.
Параметры
- boolean
$allнеобязательно false - Очистить весь кэш или нет
close()source public
close( )
Закрывает текущий файл, если он открыт.
Возвращает
booleanTrue, если закрытие прошло успешно или файл был уже закрыт, иначе false
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::closecopy()source public
copy( string $dest , boolean $overwrite true )
Скопировать файл в $dest
Параметры
- string
$dest - Место назначения для копирования
- boolean
$overwriteнеобязательно true - Перезаписать $dest, если он существует
Возвращает
booleanУспех
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::copycreate()source public
create( )
Создает файл.
Возвращает
booleanУспех
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::createdelete()source public
delete( )
Удаляет файл.
Возвращает
booleanУспех
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::deleteexecutable()source public
executable( )
Возвращает true, если файл исполняемый.
Возвращает
booleanTrue, если файл исполняемый, иначе false
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::executableexists()source public
exists( )
Возвращает true, если файл существует.
Возвращает
booleanTrue, если файл существует, иначе false
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::existsext()source public
ext( )
Возвращает расширение файла.
Возвращает
stringРасширение файла
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::extfolder()source public
folder( )
Возвращает текущую папку.
Возвращает
FolderТекущая папка
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::Foldergroup()source public
group( )
Возвращает группу файла.
Возвращает
integer|falseГруппа файла или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::groupinfo()source public
info( )
Возвращает информацию о файле в виде массива с ключами:
- dirname
- basename
- extension
- filename
- filesize
- mime
Возвращает
arrayИнформация о файле.
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::infolastAccess()source public
lastAccess( )
Возвращает время последнего доступа.
Возвращает
integer|falseОтметка времени последнего доступа или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastAccesslastChange()source public
lastChange( )
Возвращает время последнего изменения.
Возвращает
integer|falseОтметка времени последнего изменения или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastChangemd5()source public
md5( integer|boolean $maxsize 5 )
Получение контрольной суммы md5 файла с предварительной проверкой размера файла
Параметры
- integer|boolean
$maxsizeнеобязательно 5 - в МБ или true для принудительного расчёта
Возвращает
string|falseКонтрольная сумма md5 См. md5_file(), или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::md5mime()source public
mime( )
Получение MIME-типа файла. Используется расширение finfo, если оно доступно, в противном случае используется mime_content_type
Возвращает
false|stringMIME-тип файла или false, если чтение не удалось.
name()source public
name( )
Возвращает имя файла без расширения.
Возвращает
stringИмя файла без расширения.
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::nameoffset()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, определяющая относительность смещения.
Возвращает
mixedTrue при успехе, false при ошибке (режим установки), false при ошибке или целое смещение при успехе (режим получения)
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::offsetopen()source public
open( string $mode 'r' , boolean $force false )
Открывает файл с заданным режимом.
Параметры
- string
$modeнеобязательно 'r' - Строка режима 'fopen' (r|w|a ...)
- boolean
$forceнеобязательно false - Если true, файл будет переоткрыт, даже если он уже открыт; иначе нет
Возвращает
booleanTrue при успехе, false при ошибке
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::openowner()source public
owner( )
Возвращает владельца файла.
Возвращает
integer|falseВладелец файла или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::ownerperms()source public
perms( )
Возвращает разрешения файла (chmod).
Возвращает
string|falseРазрешения файла или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::permsprepare()source public static
prepare( string $data , boolean $forceWindows false )
Подготавливает строку ASCII для записи. Преобразует окончания строк в соответствующий разделитель для текущей платформы. Если Windows, будет использоваться «\r\n», на всех остальных платформах будет использоваться «\n»
Параметры
- строка
$data - Данные для подготовки к записи.
- логическое
$forceWindowsнеобязательно false - Если true, принудительно используется строка окончания строки Windows.
Возвращаемое значение
строкаСтрока с преобразованными окончаниями строк.
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::preparepwd()source public
pwd( )
Возвращает полный путь к файлу.
Возвращаемое значение
строкаПолный путь к файлу
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::pwdread()source public
read( string $bytes false , string $mode 'rb' , boolean $force false )
Возвращает содержимое файла в виде строки.
Параметры
- строка
$bytesнеобязательно false - с какой позиции начать чтение
- строка
$modeнеобязательно 'rb' - Режим, совместимый с
fread. - логическое
$forceнеобязательно false - Если true, файл будет повторно открыт, даже если он уже открыт, в противном случае не будет.
Возвращаемое значение
mixedстрока при успехе, false при ошибке
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::readreadable()source public
readable( )
Возвращает true, если файл доступен для чтения.
Возвращаемое значение
booleanTrue, если файл доступен для чтения, false в противном случае
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::readablereplaceText()source public
replaceText( string|array $search , string|array $replace )
Ищет заданный текст и заменяет его, если он найден.
Параметры
- строка|массив
$search - Текст(ы) для поиска.
- строка|массив
$replace - Текст(ы) для замены.
Возвращаемое значение
booleanУспех
safe()source public
safe( string $name null , string $ext null )
Делает имя файла безопасным для сохранения.
Параметры
- строка
$nameнеобязательно null - Имя файла для безопасного преобразования, если оно отличается от $this->name
- строка
$extнеобязательно null - Имя расширения для безопасного преобразования, если оно отличается от $this->ext
Возвращаемое значение
строкарасширение файла
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::safesize()source public
size( )
Возвращает размер файла.
Возвращаемое значение
целое число|falseРазмер файла в байтах или false в случае ошибки
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::sizewritable()source public
writable( )
Возвращает true, если файл доступен для записи.
Возвращаемое значение
booleanTrue, если доступен для записи, false в противном случае
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::writablewrite()source public
write( string $data , string $mode 'w' , boolean $force false )
Записывает заданные данные в этот файл.
Параметры
- строка
$data - Данные для записи в этот файл.
- строка
$modeнеобязательно 'w' - Режим записи. См. fwrite().
- логическое
$forceнеобязательно false - Принудительно открыть файл.
Возвращаемое значение
booleanУспех
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::writeПодробное описание свойств
$Foldersource
public Folder
Объект папки файла
Ссылка
https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::$Foldernull
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-File.html