Skip to content

File Item

Jump to bottom
Denis edited this page Dec 27, 2018 · 1 revision

\Leonied7\Yandex\Disk\Item\File

Описание

Объект для работы с файлом на Яндекс.Диске

Чаще всего работа будет происходить следущим образом:

use \Leonied7\Yandex\Disk;
$yandexDisk = new Disk('OAuth-токен');
/** @var Disk\Item\File $file */
$file = $yandexDisk->file('/path/to/file');
// дальнейшая работа с файлом

Методы

  • has([\Leonied7\Yandex\Disk\Collection\PropertyCollection $propertyCollection = null]):bool - Проверка существования файла на Яндекс.Диске
  • loadProperties(\Leonied7\Yandex\Disk\Collection\PropertyCollection $propertyCollection):\Leonied7\Yandex\Disk\Collection\PropertyCollection - Запрашивает нужные свойства с Яндекс.Диска и возвращает коллекцию \Leonied7\Yandex\Disk\Collection\PropertyCollection
  • getExistProperties(void):\Leonied7\Yandex\Disk\Collection\PropertyCollection - Запрашивает все существующие свойства с Яндекс.Диска и возвращает коллекцию Без значений!!! \Leonied7\Yandex\Disk\Collection\PropertyCollection
  • getProperties(void):\Leonied7\Yandex\Disk\Collection\PropertyCollection|null - Возвращает ранее полученные свойства методами has() или loadProperties()
  • changeProperties(\Leonied7\Yandex\Disk\Collection\PropertyCollection $property):bool - Изменяет переданные свойства на Яндекс.Диске
  • saveProperties(void):bool - Сохраняет изменнёную коллекцию свойств полученную из loadProperties()/getProperties() на Яндекс.Диске
  • move(string $destination[, $overwrite = true]):bool - Перемещение/Переименование файла. Метод getPath() начнёт возвращать новый путь
  • copy(string $destination[, $overwrite = true]):bool - Копирование файла
  • delete(void):bool - Удаление файла
  • upload(\Leonied7\Yandex\Disk\Model\Stream $stream):bool - загрузка файла на Яндекс.Диск
  • download([\Leonied7\Yandex\Disk\Model\Stream $stream = null[, int $from = 0[, int $to = null]]]):bool - скачивание файла с Яндекс.Диска
  • getPreview(string $size = 'M'[, \Leonied7\Yandex\Disk\Model\Stream $stream = null]):bool - получение превью файла с Яндекс.Диска
  • startPublish(void):boold - начать публикацию файла
  • stopPublish(void):boold - остановить публикацию файла
  • checkPublish(void):boold - проверить публикацию файла
  • getPath(void):string - путь текущего файла
  • isFile(void):bool - является ли объект файлом
  • isDirectory(void):bool - является ли объект директорией
  • getType(void):stirng - возвращает file/directory в зависимости от типа элемента
  • getBuilder(void):\Leonied7\Yandex\Disk\Builder\File - возвращает построитель запросов. Может быть использован для асинхронных запросов

Clone this wiki locally