Описание класса YandexImageRequest | Universal Bot

YandexImageRequest extends YandexRequest
in

Класс отвечающий за загрузку изображений в навык.

Class YandexRequest

Table of Contents

STANDARD_URL 'https://dialogs.yandex.net/api/v1/'
$skillId Идентификатор навыка, необходимый для корректного сохранения изображения (Обязательный параметр) string|null
$request Отправка запроса. Request
$oauth Авторизационный токен. string|null
$error Текст с ошибкой string|null
__construct() YandexImageRequest constructor. mixed
getImagesUrl() Получение адреса для загрузки изображения. string
checkOutPlace() Проверка занятого места. array|null
downloadImageUrl() Загрузка изображения из интернета. array|null
downloadImageFile() Загрузка изображения из файла. array|null
getLoadedImages() Просмотр всех загруженных изображений. array|null
deleteImage() Удаление выбранного изображения. string|null
deleteImages() Удаление всех изображений. bool
__construct() YandexRequest constructor. mixed
setOAuth() Установка и инициализация токена. void
call() Отправка запроса для обработки данных. mixed
log() Сохранение логов void

Constants

Properties

$skillId

Идентификатор навыка, необходимый для корректного сохранения изображения (Обязательный параметр)

public string|null $skillId

$oauth

Авторизационный токен.

protected string|null $oauth

$error

Текст с ошибкой

protected string|null $error

Methods

__construct()

YandexImageRequest constructor.

public __construct( [ $oauth : string|null = null ] [, $skillId : string|null = null ] ) : mixed
Parameters
$oauth : string|null = null

Авторизационный токен для загрузки изображений.

$skillId : string|null = null

Идентификатор навыка.

Tags
see
  • Документация.
see
  • Получение токена.
Return values
mixed

getImagesUrl()

Получение адреса для загрузки изображения.

private getImagesUrl( ) : string
Return values
string

checkOutPlace()

Проверка занятого места.

public checkOutPlace( ) : array|null
Tags
api
throws
Return values
array|null —

[

  • int total: Все доступное место.
  • int used: Занятое место. ]

downloadImageUrl()

Загрузка изображения из интернета.

public downloadImageUrl( $imageUrl : string ) : array|null
Parameters
$imageUrl : string

Адрес изображения из интернета.

Tags
api
throws
Return values
array|null —

[

  • string id: Идентификатор изображения.
  • string origUrl: Адрес изображения.
  • int size: Размер изображения.
  • int createdAt: Дата загрузки. ]

downloadImageFile()

Загрузка изображения из файла.

public downloadImageFile( $imageDir : string ) : array|null
Parameters
$imageDir : string

Адрес изображения из интернета.

Tags
api
throws
Return values
array|null —

[

  • string id: Идентификатор изображения.
  • string origUrl: Адрес изображения.
  • int size: Размер изображения.
  • int createdAt: Дата загрузки. ]

getLoadedImages()

Просмотр всех загруженных изображений.

public getLoadedImages( ) : array|null
Tags
api
throws
Return values
array|null —

[ [

  • string id: Идентификатор изображения.
  • string origUrl: Адрес изображения.
  • int size: Размер изображения.
  • int createdAt: Дата загрузки. ] ]

deleteImage()

Удаление выбранного изображения.

public deleteImage( $imageId : string ) : string|null

В случае успеха вернет 'ok'.

Parameters
$imageId : string

Идентификатор изображения, которое необходимо удалить.

Tags
api
throws
Return values
string|null

deleteImages()

Удаление всех изображений.

public deleteImages( ) : bool

Если при удалении произошел сбой, то изображение останется. Чтобы точно удалить все изображения лучше использовать грубое удаление.

Tags
api
throws
Return values
bool

__construct()

YandexRequest constructor.

public __construct( [ $oauth : string|null = null ] ) : mixed
Parameters
$oauth : string|null = null

Авторизационный токен для загрузки данных.

Return values
mixed

setOAuth()

Установка и инициализация токена.

public setOAuth( $oauth : string|null ) : void
Parameters
$oauth : string|null

Авторизационный токен для загрузки данных.

Tags
api

call()

Отправка запроса для обработки данных.

public call( [ $url : string|null = null ] ) : mixed
Parameters
$url : string|null = null

Адрес запроса.

Tags
api
throws
Return values
mixed

log()

Сохранение логов

protected log( $error : string ) : void
Parameters
$error : string

Текст ошибки

Tags
throws
api

Search results