Download the PHP package s00d/yandex without Composer

On this page you can find all versions of the php package s00d/yandex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of s00d/yandex

Informations about the package yandex

Введение

Неофициальное PHP SDK для некоторых сервисов Яндекса: сервис Яндекс.Диск.

Список изменений

5/7/2022

21/12/2020

23/08/2016

Требования

Внести свой вклад в развитие

Вы можете сообщить о найденных неточностях в работе SDK, приветствуется помощь в разработке. Чтобы начать помогать вести разработку Вам нужно создать fork репозитория ветки development, внесите изменения в код и отправьте pull request нам с изменениями в ветку development.

Установка

Поддерживается установка с помощью менеджера пакетов.

Или

Тесты

Вы можете не найти некоторых тестов - мы их не публикуем по причинам приватности.

1. Сервис Яндекс.Диск

1.1. Введение

PHP SDK для работы с Яндекс.Диском, в своей основе использует REST API диска. API диска для аунтификации использует OAuth-токен (например, 0c4181a7c2cf4521964a72ff57a34a07), который Вы должны получить самостоятельно:

SDK работает только с отладочными токенами. OAuth-токен должен иметь разрешённые права "Яндекс.Диск REST API".

Ресурс - файл или папка на Яндекс.Диске. SDK определяет три состояния ресурса: публичный, закрытый, и тот который помещён в корзину.

1.1.1. Возможности

Основные моменты

возможно это не полный список

Плагины, дополнения, адаптеры

1.1.2. Папки приложений

Приложения могут хранить на Диске пользователя собственные данные — например, настройки, сделанные этим пользователем или созданные им файлы. Чтобы запрашивать доступ к собственной папке на Диске, приложение следует зарегистрировать с правом "Доступ к папке приложения на Диске". Такое приложение сможет оперировать файлами только в рамках своей папки, если не получит также прав на общий доступ к Диску. SDK различает общий доступ и доступ приложения к собственной папке, префиксами "disk:/" и "app:/" соответственно. Тем не менее в информации о ресурсе пути указываются в схеме disk:/, с абсолютными путями к ресурсам, например "disk:/Приложения/МоёПервоеПриложение/photo.png".

1.1.3. Пример использования

SDK вызывает исключения по каждой ситуации, следующий пример показывает как это можно использовать.

1.2. Как подключиться к Яндекс.Диску

Обращение к Яндекс.Диску осуществляется через Arhitector\Yandex\Disk. После получения OAuth-токена, его (OAuth-токен) можно использовать следующим образом:

Один и тот же OAuth-токен может быть использован для доступа к разным сервисам.

Инициализировать клиент Яндекс.Диска и передать $client.

Вы можете установить или изменить OAuth-токен в ранее инициализированном объекте.

Или изменить OAuth-токен для клиента Яндекс.Диска

На этом этапе есть несколько переменных, например $disk и $client, которые будут использованы далее в документации для отсылки к определённым объектам.

Примечание: Arhitector\Yandex\Client\OAuth не является реализацией протокола OAuth 2.0.

1.2.1. Установить OAuth-токен

Устанавливает OAuth-токен для прохождения аунтификации на сервисах. Не все операции требуют OAuth-токен.

Примеры

или

1.2.2. Получить установленный OAuth-токен

Получает ранее установленный OAuth-токен или NULL.

Примеры

или

1.3. Работа с Яндекс.Диском

SDK различает три типа ресурсов: публичный, закрытый, и тот который помещён в корзину. Каждый из типов представлен своим объектом. Для любого типа ресурса доступна фильтрация (методы setMediaType, setType и т.д.) у каждого из типов свой набор возможных значений.

Введение

Существуют базовые методы получения всевозможного рода информации, которые доступны везде. Кроме прочего, поддерживаются обращения к фиктивным свойствам и работа с объектом как с массивом.

1.3.1. Метод get

Получить значение по ключу.

$index - индекс/ключ, по которому получить значение (free_space, name и т.д.)

$default - значение по умолчанию, если такой индекс отсутствует - может принимать анонимную функцию, которая будет вызвана с текущим контекстом (Disk, Closed, и т.д.)

Примеры

1.3.2. Метод toArray

Получает содержимое всего контейнера в виде массива.

Примечание: метод не является рекурсивным, это означает, что вложенные ресурсы (например, файлы в папке) не будут преобразованы в массив, а результатом будет массив объектов т.е. массив ресурсов (файлы, папки), представленные своим объектом.

$allowed - массив ключей, которые необходимо вернуть.

Примеры

1.3.3. Метод toObject

Получает содержимое всего контейнера в виде объекта.

Примечание: метод не является рекурсивным, это означает, что вложенные ресурсы (например, файлы в папке) не будут преобразованы в объект, а результатом будет коллекция объектов.

$allowed - получить только эти ключи.

Примеры

1.3.4. Метод getIterator

Получает итератор. Вы можете использовать объекты SDK в циклах.

Примеры

Проход циклом, например, $resource является папкой. Получим вложенные файлы/папки в эту папку.

1.3.5. Метод count

Подсчитывает количество чего-то.

Возвращает количество асинхронных операций экземпляра:

Возвращает количество полей:

Примеры

1.3.6. Методы has, hasProperty

Метод has

Поведение метода has отличается в зависимости от контекста. Может проверить существует ли свойство или существует ли такой ресурс на Яндекс.Диске.

Примечание: возможно в будущем поведение метода будет упрощено.

$key - необязательный параметр, индекс.

Метод hasProperty

Тоже самое что и метод has, но выполняет только одно действие - проверка свойства на существование и доступен только в контексте ресурса Resource\\*

$key - индекс/свойство для проверки на существование.

Примеры

1.3.7. Получение информации о диске.

Методы получения информации описаны выше.

Вернёт массив, примерно такого содержания. Метод toObject возвращает соответственно объект.

Метод count тут вернёт количество инициированных асинхронных операций.

Доступные ключи для метода get

1.3.8. Работа с закрытыми ресурсами.

Работа с ресурсами на диске осуществляется через метод ы Disk::getResource и Disk::getResources, доступ к которым имеет владелец диска. Не имеет значения существует ли ресурс на диске в данный момент или нет. Разница в том, что когда ресурс существует - есть возможность запросить информацию о ресурсе в другом случае будет вызвано исключение NotFoundException. По факту для ресурса, который еще не существует доступна только операция загрузки на диск - upload, после чего операции публикации, удаления и т.п. смогут корректно выполняться.

Метод Disk::getResource

Получает объектно ориентированное представление конкретного ресурса на Яндекс.Диске. Доступ к такому ресурсу имеет владелец диска.

$path - Путь к новому либо уже существующему ресурсу.

$limit - Количество ресурсов в ответе.

$offset - Смещение. Задаётся для списка всех файлов или если ресурс является папка, то задаёт смещение вложенных в папку ресурсов.

Примеры

Получить объект ресурса.

Получить объект ресурса из папки приложения.

Установить $limit и offset можно и после получения объекта ресурса методами setLimit и setOffset.

Метод Disk::getResources, список всех файлов.

Получает список всех файлов в папках, под папках и т.д. Список представлен объектом Arhitector\Yandex\Disk\Resource\Collection.

Здесь доступны методы фильтрации, основные методы получения информации и ряд других.

Примеры

Список файлов в папках также представлен объектом Arhitector\Yandex\Disk\Resource\Collection

Метод getFirst

Получает первый ресурс в списке. Это может быть Closed, Opened, Removed.

Примеры

Метод getLast

Метод коллекции, получает последний элемент.

Примеры

Методы фильтрации

Все это дело происходит на стороне API. Для коллекции доступны методы

1.3.8.1. Проверить ресурс на существование

Проверить, существует ли ресурс на диске поможет ранее описанный метод has (вызывается без параметров). Если использовать с параметром - проверяет существует ли свойство.

Примечание: возможно в будущем метод будет упрощен.

Примеры

1.3.8.2. Получение информации о ресурсе

Осуществляется с помощью основных методов получения информации, описанных ранее.

Примеры

1.3.8.3. Ресурс является файлом/папкой

Для этого существуют методы isFile и isDir.

Примеры

1.3.8.4. Ресурс публичный/или доступен только владельцу

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

Примеры

1.3.8.5. Путь к ресурсу на диске

Для этого можно воспользоваться методом getPath. Этот путь использует SDK, но хоть значение может и отличаться от того, которое может возвращать Яндекс.Диск, такое не совпадение вполне корректно.

Примеры

1.3.8.6. Добавление/удаление метаинформации для ресурса

Добавленная метаинформация хранится в свойстве "custom_properties". Максимальная длина объекта (ключи + значения) 1024 байта. Значение не должно быть NULL.

$meta - строка либо массив значений.

$value - NULL чтобы удалить определённую метаинформацию когда $meta строка.

Примеры

Удаление информации

Чтобы удалить метаинформацию необходимо установить значение NULL.

Примеры

метод getProperty

Работает со свойством "custom_properties" - в нём хранится добавляемая метаинформация. Метод похож на метод get.

Примечание: возможно в будущем метод будет переименован.

$index - ключ, по которому получить значение.

$default - значение по умолчанию, если такой индекс отсутствует - может принимать анонимную функцию, которая будет вызвана с текущим контекстом (только Resource\Closed).

Примеры

Метод getProperties

Получает массив всей метаинформации.

Примеры

1.3.8.7. Удаление файла или папки

Удалить совсем или поместить файл или папку в корзину можно методом delete.

$permanently - признак безвозвратного удаления. FALSE поместит ресурс в корзину (поведение по умолчанию).

Возвращаемые значения:

Примеры

1.3.8.8. Перемещение файла или папки

Перемещать файлы и папки на Диске можно, указывая новое положение ресурса.

$destination - новое расположение ресурса. Может быть строкой или Resource\Closed.

$overwrite - boolean признак перезаписи, если по новому пути существует ресурс. TRUE перезапишет (поведение по умолчанию FALSE - не перезаписывать).

Возвращаемые значения

bool или объект Arhitector\Yandex\Disk\Operation

Примеры

1.3.8.9. Создание папки

Если ресурс уже существует будет вызвано исключение AlreadyExists.

Примеры

1.3.8.10. Публикация ресурса\Закрытие доступа

Открывает доступ к ресурсу из вне по публичной ссылке. Опубликованные ресурсы управляются своим объектом Arhitector\Yandex\Disk\Resource\Opened.

$publish - признак публичности, TRUE сделать ресурс публичным (поведение по умолчанию), FALSE отменить публикации ресурса.

Возвращаемые значения

Arhitector\Yandex\Disk\Resource\Closed возвращается когда доступ закрыт.

Arhitector\Yandex\Disk\Resource\Opened возвращается если был открыт доступ к ресурсу.

У ресурса с открытым доступом существует дополнительная информация, такая как public_key или public_url. Также docviewer возвращает ссылку доступную всем из вне.

Примеры

1.3.8.11. Скачивание файла

Метод download безопасен от переполнения памяти и может быть использован для скачивания файлов и папок (автоматически в виде zip-архива).

$destination - позволяет указать куда будет сохранён ресурс.

Поддерживаются следующие типы:

$overwrite - используется совместно с $destination строкового типа string, определяет поведение (перезаписать/не перезаписывать), если по такому пути существует локальный файл.

Возвращаемые значения

TRUE или FALSE, а также вызывает исключения по типовым событиям, например, AlreadyExistsException или NotFoundException.

Примеры

Скачать файл в локальную папку.

Запись в открытый дескриптор.

Использовать обертку над потоком так же просто.

1.3.8.12. Копирование файла или папки

Сделать копию ресурса.

$destination - путь до нового ресурса.

Может принимать значения:

$overwrite - признак перезаписи, если по указанному пути существует ресурс. Поведение по умолчанию FALSE.

Возвращаемые значения

TRUE или FALSE, а также Arhitector\Yandex\Disk\Operation в случае длительного копирования.

Примеры

1.3.8.13. Загрузка файла

Метод upload безопасен от утечки памяти и используется для загрузки файлов на Яндекс.Диск. Может загружать как файлы расположенные локально, в локальной папке, так и, файлы расположенные на удаленном хостинге/сервере и доступные по URL-адресу.

$file_path - может быть как путь к локальному файлу, так и URL к файлу.

Принимает значения:

$overwrite - признак перезаписи, если ресурс на Яндекс.Диске существует. Параметр не влияет на загрузку файлов по URL-адресу.

$disable_redirects - параметр влияет на файлы, загружаемые по URL-адресу. TRUE помогает запретить перенаправление по адресу. Поведение по умолчанию FALSE - пре адресация разрешена.

Примеры

Загрузка локального файла.

Загрузка файлов, расположенных на удалённом сервере. Возвращает объект операции Arhitector\Yandex\Disk\Operation.

1.3.8.14. Методы фильтрации

Объект Arhitector\Yandex\Disk\Resource\Closed поддерживает:

1.3.9. Работа с публичными ресурсами.

Работа с ресурсами с открытым доступом осуществляется через методы Disk::getPublishResource и Disk::getPublishResources, доступ к которым имеет владелец диска.

Метод Disk::getPublishResource

Получает объектно ориентированное представление конкретного ресурса на Яндекс.Диске с открытым доступом.

$public_key - публичный ключ или URL-адрес ресурса с открытым доступом.

$limit - Количество ресурсов в ответе, если это папка.

$offset - Смещение. Задаётся для списка всех файлов или если ресурс является папка, то задаёт смещение вложенных в папку ресурсов.

Примеры

Получить объект ресурса.

Установить $limit и offset можно и после получения объекта ресурса методами setLimit и setOffset.

Метод Disk::getPublishResources, список всех опубликованных файлов.

Получает список всех файлов на Яндекс.Диске с открытым доступом и т.д. Список представлен объектом Arhitector\Yandex\Disk\Resource\Collection.

Здесь доступны методы фильтрации, основные методы получения информации и ряд других.

Примеры

Методы фильтрации

Все это дело происходит на стороне API. Для коллекции доступны методы

1.3.9.1. Получить публичный ключ

Получает публичный ключ или URL, который был использован для получения доступа к ресурсу.

Примеры

1.3.9.2. Получает прямую ссылку

Получить прямую ссылку на скачивание файла или папки.

Примечание: возвращаемая ссылка действует ("живет") пару часов.

Примечание: метод не поддерживает получение ссылок на ресурсы внутри публичной папки. Эта возможность реализуема, но не реализована.

Примеры

1.3.9.3. Скачивание публичного файла или папки.

Скачивание публичного файла или папки (в виде zip-архива).

$destination - Путь, по которому будет сохранён файл

Принимает значения:

$overwrite - флаг перезаписи, если $destination является файловым путем. FALSE - поведение по умолчанию.

$check_hash - провести проверку целостности скачанного файла. Значение TRUE позволяет проверить md5 хеш скачанного файла. По умолчанию FALSE.

Примеры

Запись в открытый дескриптор.

Использовать обертку над потоком так же просто.

1.3.9.4. Есть ли доступ к этому файлу от имени владельца.

/**

1.3.9.5. Сохранение публичного файла в «Загрузки».

/**
 * Сохранение публичного файла в «Загрузки» или отдельный файл из публичной папки
 *
 * @param    string $name Имя, под которым файл следует сохранить в папку «Загрузки»
 * @param    string $path Путь внутри публичной папки.
 *
 * @return    mixed
 */
 public function save($name = null, $path = null)

1.3.9.6. Установить путь внутри публичной папки.

/**
 * Устанавливает путь внутри публичной папки
 *
 * @param string $path
 *
 * @return $this
 */
 public function setPath($path)

1.3.10. Работа с файлами в корзине.

/**
 * Ресурсы в корзине.
 *
 * @param    string $path путь к файлу в корзине
 * @param int       $limit
 * @param int       $offset
 *
 * @return \Arhitector\Yandex\Disk\Resource\Removed
 * @example
 *
 * $disk->getTrashResource('file.ext') -> toArray() // файл в корзине
 * $disk->getTrashResource('trash:/file.ext') -> delete()
 */
public function getTrashResource($path, $limit = 20, $offset = 0)

/**
 * Содержимое всей корзины.
 *
 * @param int $limit
 * @param int $offset
 *
 * @return \Arhitector\Yandex\Disk\Resource\Collection
 */
public function getTrashResources($limit = 20, $offset = 0)

1.3.10.1. Восстановить ресурс из корзины.

/**
 *  Восстановление файла или папки из Корзины
 *  В корзине файлы с одинаковыми именами в действительности именют постфикс к имени в виде unixtime
 *
 *  @param  mixed   $name   оставляет имя как есть и если boolean это заменяет overwrite
 *  @param  boolean $overwrite
 *  @return mixed
 */
public function restore($name = null, $overwrite = false)

1.3.10.2. Удалить ресурс из корзины.

/**
 * Удаление файла или папки
 *
 * @return    mixed
 */
public function delete()

1.3.11. Очистка корзины.

/**
 * Очистить корзину.
 *
 * @return bool|\Arhitector\Yandex\Disk\Operation
 */
public function cleanTrash()

1.3.12. Последние загруженные файлы.

/**
 * Последние загруженные файлы
 *
 * @param    integer $limit
 * @param    integer $offset
 *
 * @return   \Arhitector\Yandex\Disk\Resource\Collection
 *
 * @example
 *
 * $disk->uploaded(limit, offset) // коллекия закрытых ресурсов
 */
public function uploaded($limit = 20, $offset = 0)

1.3.13. Синхронные операции.

/**
 * Получить статус операции.
 *
 * @param   string $identifier идентификатор операции или NULL
 *
 * @return  \Arhitector\Yandex\Disk\Operation
 *
 * @example
 *
 * $disk->getOperation('identifier operation')
 */
public function getOperation($identifier)

/**
 * Возвращает количество асинхронных операций экземпляра.
 *
 * @return int
 */
public function count()

    /**
 * Получить все операции, полученные во время выполнения сценария
 *
 * @return array
 *
 * @example
 *
 * $disk->getOperations()
 *
 * array (size=124)
 *  0 => 'identifier_1',
 *  1 => 'identifier_2',
 *  2 => 'identifier_3',
 */
public function getOperations()

1.3.14. Методы фильтрации.

/**
 * Количество ресурсов, вложенных в папку, описание которых следует вернуть в ответе
 *
 * @param    integer $limit
 * @param    integer $offset установить смещение
 *
 * @return   $this
 */
public function setLimit($limit, $offset = null)

/**
 * Количество вложенных ресурсов с начала списка, которые следует опустить в ответе
 *
 * @param    integer $offset
 *
 * @return    $this
 */
public function setOffset($offset)

    /**
 * Атрибут, по которому сортируется список ресурсов, вложенных в папку.
 *
 * @param    string  $sort
 * @param    boolean $inverse TRUE чтобы сортировать в обратном порядке
 *
 * @return    $this
 * @throws    \UnexpectedValueException
 */
public function setSort($sort, $inverse = false)

'Допустимые значения сортировки - name, path, created, modified, size'

    /**
 * Тип файлов, которые нужно включить в список
 *
 * @param    string $media_type
 *
 * @return    $this
 * @throws    \UnexpectedValueException
 */
public function setMediaType($media_type)
Тип файлов, которые нужно включить в список. Диск определяет тип каждого файла при загрузке.

Чтобы запросить несколько типов файлов, можно перечислить их в значении параметра через запятую. Например, media_type="audio,video". Поддерживаемые типы: audio — аудио-файлы. backup — файлы резервных и временных копий. book — электронные книги. compressed — сжатые и архивированные файлы. data — файлы с базами данных. development — файлы с кодом (C++, Java, XML и т. п.), а также служебные файлы IDE. diskimage — образы носителей информации в различных форматах и сопутствующие файлы (например, CUE). document — документы офисных форматов (Word, OpenOffice и т. п.). encoded — зашифрованные файлы. executable — исполняемые файлы. flash — файлы с флэш-видео или анимацией. font — файлы шрифтов. image — изображения. settings — файлы настроек для различных программ. spreadsheet — файлы офисных таблиц (Numbers, Lotus). text — текстовые файлы. unknown — неизвестный тип. video — видео-файлы. web — различные файлы, используемые браузерами и сайтами (CSS, сертификаты, файлы закладок).

    /**
 * Получает установленное значение.
 *
 * @return  string
 */
public function getMediaType()

    /**
 * Все возможные типы файлов
 *
 * @return array
 */
public function getMediaTypes()

    /**
 * Обрезать превью согласно размеру
 *
 * @param    boolean $crop
 *
 * @return    $this
 */
public function setPreviewCrop($crop)
Параметр позволяет обрезать превью согласно размеру, заданному в значении параметра preview_size.

Допустимые значения: «false» — параметр игнорируется. Это значение используется по умолчанию. «true» — превью обрезается следующим образом: Если передана только ширина или высота, картинка уменьшается до этого размера с сохранением пропорций. Затем из центра уменьшенного изображения также вырезается квадрат с заданной стороной. Если передан точный размер (например, «120x240»), из центра оригинального изображения вырезается фрагмент максимального размера в заданных пропорциях ширины и высоты. Затем вырезанный фрагмент масштабируется до указанных размеров.

    /**
 * Размер уменьшенного превью файла
 *
 * @param    mixed $preview S, M, L, XL, XXL, XXXL, <ширина>, <ширина>x, x<высота>, <ширина>x<высота>
 *
 * @return    $this
 * @throws    \UnexpectedValueException
 */
public function setPreview($preview)
Вы можете задать как точный размер превью, так и размер одной из сторон. Получившееся изображение можно обрезать до квадрата с помощью параметра preview_crop.

Варианты значений: Предопределенный размер большей стороны. Картинка уменьшается до указанного размера по большей стороне, пропорции исходного изображения сохраняются. Например, для размера «S» и картинки размером 120×200 будет сгененерировано превью размером 90×150, а для картинки 300×100 — превью размером 150×50. Поддерживаемые значения: «S» — 150 пикселей; «M» — 300 пикселей; «L» — 500 пикселей; «XL» — 800 пикселей; «XXL» — 1024 пикселей; «XXXL» — 1280 пикселей. Точная ширина (например, «120» или «120x») или точная высота (например, «x145»). Картинка уменьшается до указанной ширины или высоты, пропорции исходного изображения сохраняются. Если передан параметр preview_crop, из центра уменьшенного изображения также вырезается квадрат с заданной стороной. Точный размер (в формате <ширина>x<высота>, например «120x240»). Картинка уменьшается до меньшего из указанных размеров, пропорции исходного изображения сохраняются. Если передан параметр preview_crop, из центра оригинального изображения вырезается фрагмент максимального размера в заданных пропорциях ширины и высоты (в примере — 1/2). Затем вырезанный фрагмент масштабируется до указанных размеров.

    /**
 * Получает установленное значение "setPreview".
 *
 * @return  string
 */
public function getPreview()

    /**
 * Получает установленное значение "setPreviewCrop".
 *
 * @return  string
 */
public function getPreviewCrop()

    /**
 * Относительный путь к ресурсу внутри публичной папки.
 *
 * @param    string $path
 *
 * @return    $this
 */
public function setRelativePath($path)

    /**
 * Получает установленное значение.
 *
 * @return  string
 */
public function getRelativePath()

    /**
 * Тип ресурса
 *
 * @param    string $type
 *
 * @return    $this
 * @throws    \UnexpectedValueException
 */
public function setType($type)

    /**
 * Получает установленное значение.
 *
 * @return  string
 */
public function getType()

1.3.15 События.

Ресурсы поддерживают свои события. Чтобы получить больше информации читайте описание событий клиента (описано ниже). Список доступных событий:

Отличие от событий делигируемых клиентом заключается в видимости этих событий. Клиент устанавливает события для всех ресурсов, не смотря на это каждый ресурс может принимать свои собственные события.

Событие может принимать несколько обработчиков. Обработчики событий не заменяют друг друга, а добавляются в очередь.

Примеры

Стандарты кодирования

Эти стандарты должны соблюдаться при внесении изменений в код. В основе стандарта используется PSR-2 с некоторыми изменениями.

Управляющие структуры

Ключевые слова, такие как if, for, foreach, while, switch должны сопровождаться пробелом перед списком параметров/аргументов. Фигурные скобки должны располагаться на новой линии и разрыв должен соблюдать ту же вложенность.

Сравнения и логические операторы

Оператор ! должен быть окружён пробелами с обеих сторон.

1. Базовый клиент для общения с сервисами Яндекса

Базовый клиент предоставляет функциональность для прохождения аунтификации на сервисах Яндекса, использующих протокол OAuth. Наследуется другими клиентами для определённых сервисов (например, Mackey\Yandex\Disk также наследует методы базового клиента).

$token - необязательный параметр, OAuth-токен приложения.

Примеры

1.1. Формат обмена данными

Получает информацию о формате, в котором происходит общение с сервисами.

Примеры

1.2. Установить ID приложения

Устанавливает ID зарегистрированного приложения.

$client_id - строка, ID приложения

Примеры

1.3. Получить ID приложения

Возвращает ID приложения, если таковой был ранее установлен с помощью метода setClientOauth.

Пример

1.4. Установить пароль приложения

Устанавливает пароль приложения. Пароль приложения выдается при регистрации этого приложения.

Примеры

1.5. Получить пароль приложения

Возвращает ранее установленный пароль приложения или NULL.

Примеры

1.6. Установить OAuth-токен

Устанавливает OAuth-токен для прохождения аунтификация на сервисах. Не ве сервисы требуют OAuth-токен.

Примеры

1.7. Получить установленный OAuth-токен

Получает ранее установленный OAuth-токен или NULL.

Примеры

1.8. Запросить новый или обновить уже выданный OAuth-токен

Позволяет получить OAuth-токен или обновить уже выданный ранее токен для приложения.

В случае успеха возвращает объект с информацией или только OAuth-токен если передан параметр $onlyToken = true.

$username - имя пользователя аккаунта, на котором зарегистрировано приложение

$password - пароль от аккаунта

$onlyToken - вернуть только строковый токен

Примеры

1.9. Установить обработчик события

SDK поддерживает события. Каждый сервис имеет свой набор возможных событий. Перейдите на http://event.thephpleague.com/2.0/ для получения более полной информации.

$event - событие

$listener - обработчик ListenerInterface или callable

$priority - приоритет. League\Event\EmitterInterface предопределяет 3 приоритета:

Примеры

1.10. Удалить обработчик для события

Удаляет ранее установленный обработчик.

$event - событие

$listener - обработчик ListenerInterface или callable

Примеры

1.11. Установить одноразовый обработчик

Устанавливает обработчик.

$event - событие

$listener - обработчик ListenerInterface или callable

$priority - приоритет. League\Event\EmitterInterface предопределяет 3 приоритета:

Примеры

1.12. Удалить все обработчики события

Удалить все ранее утсановленные обработчики.

$event - событие

Примеры

1.13. Обработчик события на основе класса

Добавляет слушатель на основе класса.

$provider - объект класса

Примеры

1.14. Запустить событие

Выполняет вызов слушателей события.

$event - событие

Примеры

All versions of yandex with dependencies

PHP Build Version
Package Version
Requires php Version >=7.3|^8.1|^8.2|^8.3
laminas/laminas-diactoros Version ^2.5
league/event Version ^2.2
php-http/curl-client Version ^2.2.1
php-http/message Version ^1.13.0
php-http/client-common Version ^2.5.0
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package s00d/yandex contains the following files

Loading the files please wait ....