Spec-Zone.ru › CakePHP 2.7

Класс файла

Утилитарный класс для чтения, записи и добавления в файлы.

Пакет: Cake\Utility
Авторские права: 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#File

__destructsource public

__destruct( )

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

appendsource 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::append

clearStatCachesource public

clearStatCache( boolean $all false )

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

Для версий 5.3 и выше можно очистить кэш только для одного файла. Передача true очистит весь кэш stat.

Параметры

boolean $all необязательно false
Очистить весь кэш или нет

closesource public

close( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::close

copysource 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::copy

createsource public

create( )

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

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::create

deletesource public

delete( )

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

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::delete

executablesource public

executable( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::executable

existssource public

exists( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::exists

extsource public

ext( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::ext

foldersource public

folder( )

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

Возвращает

Folder
Текущая папка

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::Folder

groupsource public

group( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::group

infosource public

info( )

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::info

lastAccesssource public

lastAccess( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastAccess

lastChangesource public

lastChange( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::lastChange
END_OF_DOCUMENT_MARKER

md5source 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::md5

mimesource 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::name

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::offset

opensource public

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

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

Параметры

string $mode необязательно 'r'
Правильный строковый режим 'fopen' (r|w|a ...)
boolean $force необязательно false
Если true, файл будет повторно открыт, даже если он уже открыт, в противном случае не будет

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::open

ownersource public

owner( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::owner

permssource public

perms( )

Возвращает права (chmod) файла.

Возвращает

string|false
Права файла, или false в случае ошибки

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::perms

preparesource 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::prepare

pwdsource public

pwd( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::pwd

readsource 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::read

readablesource public

readable( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::readable

replaceTextsource 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::safe

sizesource public

size( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::size

writablesource public

writable( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::writable
END_OF_DOCUMENT_MARKER

writesource 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

Краткое описание свойств

$Foldersource

public Folder

Объект папки файла

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#File::$Folder
null

$handlesource

public resource

Содержит ресурс обработчика файла, если файл открыт

null

$infosource

public array

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

array()

$locksource

public boolean

Включить блокировку для чтения и записи файла

null

$namesource

public string

Имя файла

null

$pathsource

public mixed

Свойство пути

Абсолютный путь к текущему файлу

null

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API