Класс файла
Утилитарный класс для чтения, записи и добавления в файлы.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение Cake/Utility/File.php
Подробное описание методов
__constructsource public
__construct( string $path , boolean $create false , integer $mode 0755 )
Конструктор
Параметры
- string
$path - Путь к файлу
- boolean
$createнеобязательно false - Создать файл, если он не существует (если true)
- integer
$modeнеобязательно 0755 - Режим, применяемый к папке, содержащей файл
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Fileappendsource public
append( string $data , string $force false )
Добавить заданную строку данных в этот файл.
Параметры
- string
$data - Данные для записи
- string
$forceнеобязательно false - Вынудительно открыть файл
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::appendclearStatCachesource public
clearStatCache( boolean $all false )
Очистить внутренний кэш PHP stat
Для версий 5.3 и выше можно очистить кэш только для одного файла. Передача true очистит весь кэш stat.
Параметры
- boolean
$allнеобязательно false - Очистить весь кэш или нет
closesource public
close( )
Закрывает текущий файл, если он открыт.
Возвращает
booleanTrue, если закрытие прошло успешно или файл был уже закрыт, в противном случае false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::closecopysource public
copy( string $dest , boolean $overwrite true )
Копирует файл в $dest
Параметры
- string
$dest - Место назначения для копии
- boolean
$overwriteнеобязательно true - Перезаписать $dest, если он существует
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::copycreatesource public
create( )
Создаёт файл.
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::createdeletesource public
delete( )
Удаляет файл.
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::deleteexecutablesource public
executable( )
Возвращает true, если файл исполняемый.
Возвращает
booleanTrue, если исполняемый, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::executableexistssource public
exists( )
Возвращает true, если файл существует.
Возвращает
booleanTrue, если существует, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::existsextsource public
ext( )
Возвращает расширение файла.
Возвращает
stringРасширение файла
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::extfoldersource public
folder( )
Возвращает текущую папку.
Возвращает
FolderТекущая папка
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::Foldergroupsource public
group( )
Возвращает группу файла.
Возвращает
integer|falseГруппа файла или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::groupinfosource public
info( )
Возвращает информацию о файле в виде массива со следующими ключами:
- dirname
- basename
- extension
- filename
- filesize
- mime
Возвращает
arrayИнформация о файле.
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::infolastAccesssource public
lastAccess( )
Возвращает время последнего доступа.
Возвращает
integer|falseМаркер времени последнего доступа или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastAccesslastChangesource public
lastChange( )
Возвращает время последнего изменения.
Возвращает
integer|falseМаркер времени последнего изменения или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastChangemd5source public
md5( integer|boolean $maxsize 5 )
Получить контрольную сумму md5 файла с предварительной проверкой размера файла
Параметры
- integer|boolean
$maxsizeнеобязательно 5 - в МБ или true для принудительной проверки
Возвращает
string|falseКонтрольная сумма md5 См. md5_file(), или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::md5mimesource public
mime( )
Получить тип MIME файла. Использует расширение finfo, если оно доступно, иначе использует mime_content_type
Возвращает
false|stringТип MIME файла, или false при ошибке чтения.
namesource public
name( )
Возвращает имя файла без расширения.
Возвращает
stringИмя файла без расширения.
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::nameoffsetsource 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 при ошибке или смещение в целочисленном формате при успехе (для режима получения)
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::offsetopensource public
open( string $mode 'r' , boolean $force false )
Открывает текущий файл с заданным режимом
Параметры
- string
$modeнеобязательно 'r' - Правильный строковый режим 'fopen' (r|w|a ...)
- boolean
$forceнеобязательно false - Если true, файл будет повторно открыт, даже если он уже открыт, в противном случае не будет
Возвращает
booleanTrue при успехе, false при ошибке
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::openownersource public
owner( )
Возвращает владельца файла.
Возвращает
integer|falseВладелец файла, или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::ownerpermssource public
perms( )
Возвращает права (chmod) файла.
Возвращает
string|falseПрава файла, или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::permspreparesource public static
prepare( string $data , boolean $forceWindows false )
Подготавливает строку ASCII для записи. Преобразует окончания строк в соответствующий терминатор для текущей платформы. Если Windows, используется "\r\n", в противном случае используется "\n"
Параметры
- string
$data - Данные для подготовки к записи.
- boolean
$forceWindowsнеобязательно false - Если true, принудительно используется Windows строка новой строки.
Возвращает
stringСтроку с преобразованными окончаниями строк.
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::preparepwdsource public
pwd( )
Возвращает полный путь к файлу.
Возвращает
stringПолный путь к файлу
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::pwdreadsource public
read( string $bytes false , string $mode 'rb' , boolean $force false )
Возвращает содержимое файла в виде строки.
Параметры
- string
$bytesнеобязательно false - с какой позиции начать
- string
$modeнеобязательно 'rb' - Режим, совместимый с
fread - boolean
$forceнеобязательно false - Если true, файл будет повторно открыт, даже если он уже открыт, в противном случае не будет
Возвращает
mixedСтроку при успехе, false при ошибке
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::readreadablesource public
readable( )
Возвращает true, если файл доступен для чтения.
Возвращает
booleanTrue, если файл доступен для чтения, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::readablereplaceTextsource public
replaceText( string|array $search , string|array $replace )
Ищет заданный текст и заменяет его, если он найден.
Параметры
- string|array
$search - Текст(ы) для поиска.
- string|array
$replace - Текст(ы) для замены.
Возвращает
booleanРезультат операции
safesource public
safe( string $name null , string $ext null )
Делает имя файла безопасным для сохранения.
Параметры
- string
$nameнеобязательно null - Имя файла для безопасной обработки, если отличается от $this->name
- string
$extнеобязательно null - Имя расширения для безопасной обработки, если отличается от $this->ext
Возвращает
stringРасширение файла
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::safesizesource public
size( )
Возвращает размер файла.
Возвращает
integer|falseРазмер файла в байтах, или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::sizewritablesource public
writable( )
Возвращает true, если файл доступен для записи.
Возвращает
booleanTrue, если доступен для записи, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::writablewritesource public
write( string $data , string $mode 'w' , string $force false )
Записать данные в этот файл.
Параметры
- строка
$data - Данные для записи в этот файл.
- строка
$modeнеобязательно 'w' - Режим записи. См. fwrite().
- строка
$forceнеобязательно false - Вынудительно открыть файл
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::writeКраткое описание свойств
© 2005–2016 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.
http://api.cakephp.org/2.7/class-File.html