Класс Файл
Утилитарный класс для чтения, записи и добавления в файлы.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Utility/File.php
Краткое описание свойств
- Объект папки файла
$Folderpublic -
$handlepublicХранит ресурс обработчика файла, если файл открытresource -
$infopublicИнформация о файлеarray -
$lockpublicВключить блокировку для чтения и записи файлаboolean -
$namepublicИмя файлаstring -
$pathpublicСвойство путиmixed
Краткое описание методов
- __construct() publicКонструктор
- __destruct() publicЗакрывает текущий файл, если он открыт
- append() publicДобавляет заданную строку данных в этот файл.
- clearStatCache() publicОчистка внутренней кэшированной информации о статусе 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 )
Конструктор
Параметры
- строка
$path - Путь к файлу
- логический
$createнеобязательный false - Создать файл, если он не существует (если true)
- целое число
$modeнеобязательный 0755 - Режим, применяемый к папке, содержащей файл
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Fileappend()source public
append( string $data , string $force false )
Добавляет заданную строку данных в этот файл.
Параметры
- строка
$data - Данные для записи
- строка
$forceнеобязательный false - Принудительно открыть файл
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::appendclearStatCache()source public
clearStatCache( boolean $all false )
Очистка внутренней кэшированной информации о статусе PHP файла
Для версий PHP 5.3 и выше можно очистить кэш только для одного файла. Передача true очистит весь кэш.
Параметры
- логический
$allнеобязательный false - Очистить весь кэш или нет
close()source public
close( )
Закрывает текущий файл, если он открыт.
Возвращает
booleanTrue, если закрытие было успешным или файл был уже закрыт, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::closecopy()source public
copy( string $dest , boolean $overwrite true )
Копирует файл в $dest
Параметры
- строка
$dest - Место назначения для копирования
- логический
$overwriteнеобязательный true - Перезаписать $dest, если он существует
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::copycreate()source public
create( )
Создает файл.
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::createdelete()source public
delete( )
Удаляет файл.
Возвращает
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::deleteexecutable()source public
executable( )
Возвращает true, если файл имеет права на выполнение.
Возвращает
booleanTrue, если файл имеет права на выполнение, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::executableexists()source public
exists( )
Возвращает true, если файл существует.
Возвращает
booleanTrue, если файл существует, иначе false
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::existsext()source public
ext( )
Возвращает расширение файла.
Возвращает
stringРасширение файла
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::extfolder()source public
folder( )
Возвращает текущую папку.
Возвращает
FolderТекущая папка
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::Foldergroup()source public
group( )
Возвращает группу файла.
Возвращает
integer|falseГруппа файла или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::groupinfo()source public
info( )
Возвращает информацию о файле в виде массива с ключами:
- dirname
- basename
- extension
- filename
- filesize
- mime
Возвращает
arrayИнформация о файле.
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::infolastAccess()source public
lastAccess( )
Возвращает время последнего доступа.
Возвращает
integer|falseОтметка времени последнего доступа или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastAccesslastChange()source public
lastChange( )
Возвращает время последнего изменения.
Возвращает
integer|falseОтметка времени последнего изменения или false в случае ошибки
Ссылка
http://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 в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::md5mime()source public
mime( )
Получить тип MIME файла. Использует расширение finfo, если оно доступно, в противном случае использует mime_content_type
Возвращает
false|stringТип MIME файла или false, если чтение не удалось.
name()source public
name( )
Возвращает имя файла без расширения.
Возвращает
stringИмя файла без расширения.
Ссылка
http://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 при неудаче или смещение в виде целого числа при успехе (режим получения)
Ссылка
http://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 при неудаче
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::openowner()source public
owner( )
Возвращает владельца файла.
Возвращает
integer|falseВладелец файла или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::ownerperms()source public
perms( )
Возвращает права (chmod) файла.
Возвращает
string|falseПрава файла, или false в случае ошибки
Ссылка
http://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".
Параметры
- string
$data - Данные для подготовки к записи.
- boolean
$forceWindowsопционально false - Если true, принудительно используется строка окончания строки Windows.
Возвращает
stringСтрока с преобразованными окончаниями строк.
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::preparepwd()source public
pwd( )
Возвращает полный путь к файлу.
Возвращаемое значение
stringПолный путь к файлу
Ссылка
http://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 )
Возвращает содержимое файла в виде строки.
Параметры
- 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::readreadable()source public
readable( )
Возвращает true, если файл доступен для чтения.
Возвращаемое значение
booleanTrue, если файл доступен для чтения, false в противном случае
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::readablereplaceText()source public
replaceText( string|array $search , string|array $replace )
Ищет заданный текст и заменяет его, если найдено.
Параметры
- string|array
$search - Текст(ы) для поиска.
- string|array
$replace - Текст(ы) для замены.
Возвращаемое значение
booleanУспех
safe()source 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::safesize()source public
size( )
Возвращает размер файла.
Возвращаемое значение
integer|falseРазмер файла в байтах, или false в случае ошибки
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::sizewritable()source public
writable( )
Возвращает true, если файл доступен для записи.
Возвращаемое значение
booleanTrue, если доступен для записи, false в противном случае
Ссылка
http://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 )
Записывает заданные данные в этот файл.
Параметры
- string
$data - Данные для записи в этот файл.
- string
$modeнеобязательный 'w' - Режим записи. См. fwrite().
- boolean
$forceнеобязательный false - Принудительно открыть файл
Возвращаемое значение
booleanУспех
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::writeПодробное описание свойств
$Foldersource
public Folder
Объект Folder, соответствующий файлу
Ссылка
http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::$Foldernull
© 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.8/class-File.html