Spec-Zone.ru › CakePHP 4.3

Класс
File

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

Пространство имён: Cake\Filesystem
Устаревшее: 4.0.0 Будет удалено в 5.0.

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

  • $Folder public
    Cake\Filesystem\Folder

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

  • $handle public
    resource|null

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

  • $info public
    array<string, mixed>

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

  • $lock public
    bool|null

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

  • $name public
    string

    Имя файла

  • $path public
    string|null

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

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

  • __construct() public

    Конструктор

  • __destruct() public

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

  • _basename() protected static

    Возвращает имя файла без пути. Симулирует php basename() для многобайтовых символов (mb_basename).

  • 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() public 

__construct(string $path, bool $create = false, int $mode = 0755)

Конструктор

Параметры

string $path

Путь к файлу

bool $create optional

Создать файл, если он не существует (если true)

int $mode optional

Режим, применяемый к папке, содержащей файл

Ссылки

https://book.cakephp.org/4/en/core-libraries/file-folder.html#file-api

__destruct() public 

__destruct()

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

_basename() protected static 

_basename(string $path, string|null $ext = null): string

Возвращает имя файла. симулирует php basename() для многобайтовых символов (mb_basename).

Параметры

string $path

Путь к файлу

string|null $ext optional

Имя расширения

Возвращает

string

append() public 

append(string $data, bool $force = false): bool

Добавляет заданную строку данных в этот файл.

Параметры

string $data

Данные для записи

bool $force optional

Принудительно открыть файл

Возвращает

bool

clearStatCache() public 

clearStatCache(bool $all = false): void

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

Параметры

bool $all optional

Очистить весь кэш или нет. Передача false очистит кэш статистики только для текущего пути.

Возвращает

void

close() public 

close(): bool

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

Возвращает

bool

copy() public 

copy(string $dest, bool $overwrite = true): bool

Копирует файл в $dest

Параметры

string $dest

Абсолютный путь для копирования файла.

bool $overwrite optional

Перезаписать $dest, если существует

Возвращает

bool

create() public 

create(): bool

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

Возвращает

bool

delete() public 

delete(): bool

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

Возвращает

bool

executable() public 

executable(): bool

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

Возвращает

bool

exists() public 

exists(): bool

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

Возвращает

bool

ext() public 

ext(): string|false

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

Возвращает

string|false

folder() public 

folder(): Cake\Filesystem\Folder

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

Возвращает

Cake\Filesystem\Folder

group() public 

group(): int|false

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

Возвращает

int|false

info() public 

info(): array<string, mixed>

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

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

Возвращает

array<string, mixed>

lastAccess() public 

lastAccess(): int|false

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

Возвращает

int|false

lastChange() public 

lastChange(): int|false

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

Возвращает

int|false

md5() public 

md5(int|true $maxsize = 5): string|false

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

Параметры

int|true $maxsize optional

в MB или true для принуждения

Возвращает

string|false

mime() public 

mime(): string|false

Получает тип MIME файла. Использует расширение finfo, если оно доступно, в противном случае использует mime_content_type().

Возвращает

string|false

name() public 

name(): string|false

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

Возвращает

string|false

offset() public 

offset(int|false $offset = false, int $seek = SEEK_SET): int|bool

Устанавливает или получает смещение для текущего открытого файла.

Параметры

int|false $offset optional

Смещение в байтах для поиска. Если установлено в false, то возвращается текущее смещение.

int $seek optional

Константа PHP SEEK_SET | SEEK_CUR | SEEK_END, определяющая, относительно чего является $offset

Возвращает

int|bool

open() public 

open(string $mode = 'r', bool $force = false): bool

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

Параметры

string $mode optional

Действительная строка режима 'fopen' (r|w|a ...)

bool $force optional

Если true, то файл будет переоткрыт, даже если он уже открыт, в противном случае — нет

Возвращает

bool

owner() public 

owner(): int|false

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

Возвращает

int|false

perms() public 

perms(): string|false

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

Возвращает

string|false

prepare() public static 

prepare(string $data, bool $forceWindows = false): string

Подготавливает строку ASCII для записи. Преобразует окончания строк в правильный терминатор для текущей платформы. Если Windows, будет использоваться "\r\n", для всех остальных платформ будет использоваться "\n"

Параметры

string $data

Данные для подготовки к записи.

bool $forceWindows optional

Если true, принудительно использует строку перевода строки Windows.

Возвращает

string

pwd() public 

pwd(): string|null

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

Возвращает

string|null

read() public 

read(string|false $bytes = false, string $mode = 'rb', bool $force = false): string|false

Возвращает содержимое файла в виде строки.

Параметры

string|false $bytes необязательно

с какого байта начинать чтение

string $mode необязательно

Совместимый с fread режим.

bool $force необязательно

Если true, файл будет повторно открыт, даже если он уже открыт, в противном случае — нет

Возвращает

string|false

readable() public 

readable(): bool

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

Возвращает

bool

replaceText() public 

replaceText(array<string>|string $search, array<string>|string $replace): bool

Ищет заданный текст и заменяет его, если найдено.

Параметры

array<string>|string $search

Текст(ы) для поиска.

array<string>|string $replace

Текст(ы) для замены.

Возвращает

bool

safe() public 

safe(string|null $name = null, string|null $ext = null): string

Делает имя файла безопасным для сохранения.

Параметры

string|null $name необязательно

Имя файла для приведения к безопасному виду, если отличается от $this->name

string|null $ext необязательно

Имя расширения для приведения к безопасному виду, если отличается от $this->ext

Возвращает

string

size() public 

size(): int|false

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

Возвращает

int|false

writable() public 

writable(): bool

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

Возвращает

bool

write() public 

write(string $data, string $mode = 'w', bool $force = false): bool

Записывает заданные данные в этот файл.

Параметры

string $data

Данные для записи в этот файл.

string $mode необязательно

Режим записи. {@link https://secure.php.net/fwrite См. fwrite()}.

bool $force необязательно

Принудительно открыть файл

Возвращает

bool

Подробное описание свойств

$Folder public

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

Тип

Cake\Filesystem\Folder

$handle public

Хранит ресурс дескриптора файла, если он открыт.

Тип

resource|null

$info public

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

Тип

array<string, mixed>

$lock public

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

Тип

bool|null

$name public

Имя файла.

Тип

string

$path public

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

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

Тип

string|null

© 2005–present 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/4.3/class-Cake.Filesystem.File.html

Spec-Zone.ru

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