Spec-Zone.ru › CakePHP 2.9

Класс Файл

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

Пакет: Cake\Утилиты
Авторское право: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Utility/File.php

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

  • $Folder public
    Folder
    Объект папки файла
  • $handle public
    resource
    Содержит ресурс обработчика файла, если файл открыт
  • $info public
    array
    Информация о файле
  • $lock public
    boolean
    Включить блокировку для чтения и записи файла
  • $name public
    string
    Имя файла
  • $path public
    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) файла.
  • prepare() public static

    Подготавливает строку 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#File

__destruct()source public

__destruct( )

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

append()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::append

clearStatCache()source public

clearStatCache( boolean $all false )

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

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

Параметры

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

close()source public

close( )

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

Возвращает

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

Ссылка

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

copy()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::copy

create()source public

create( )

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

Возвращает

boolean
Успех

Ссылка

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

delete()source public

delete( )

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

Возвращает

boolean
Успех

Ссылка

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

executable()source public

executable( )

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

Возвращает

boolean
True, если разрешение на выполнение есть, иначе false

Ссылка

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

exists()source public

exists( )

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

Возвращает

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

Ссылка

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

ext()source public

ext( )

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

Возвращает

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

Ссылка

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

folder()source public

folder( )

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

Возвращает

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

Ссылка

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

group()source public

group( )

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

Возвращает

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

Ссылка

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

info()source public

info( )

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

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

Возвращает

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

Ссылка

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

lastAccess()source public

lastAccess( )

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

Возвращает

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

Ссылка

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

lastChange()source public

lastChange( )

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

Возвращает

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

Ссылка

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

md5()source public

md5( integer|boolean $maxsize 5 )

Получение контрольной суммы md5 файла с предварительной проверкой размера файла

Параметры

integer|boolean $maxsize optional 5
в МБ или true для принудительного вычисления

Возвращает

string|false
Контрольная сумма md5 См. md5_file(), или false в случае ошибки

Ссылка

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

mime()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::name

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

Возвращает

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

Ссылка

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

open()source public

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

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

Параметры

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

owner()source public

owner( )

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

Возвращает

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

Ссылка

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

perms()source public

perms( )

Возвращает разрешения ("chmod") файла.

Возвращает

string|false
Разрешения файла или false в случае ошибки.

Ссылка

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

prepare()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::prepare
END_OF_DOCUMENT_MARKER

pwd()source public

pwd( )

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

Возвращает

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

Ссылка

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

read()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::read

readable()source public

readable( )

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

Возвращает

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

Ссылка

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

replaceText()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::safe

size()source public

size( )

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

Возвращает

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

Ссылка

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

writable()source 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

write()source public

write( string $data , string $mode 'w' , boolean $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()

$locksource

public boolean

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

null

$namesource

public строка

Имя файла

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.
https://api.cakephp.org/2.9/class-File.html

Spec-Zone.ru

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