Documentation

Cloud_Handler_Onedrive_Controller extends Cloud_Controller
in package

REST API https://docs.microsoft.com/ru-ru/onedrive/developer/rest-api/

Tags
subpackage

Cloud

version
7.x
author

Hostmake LLC

copyright

© 2005-2022 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_cache  : array<string|int, mixed>
listDir Cache
$_config  : array<string|int, mixed>
Config
$_instance  : array<string|int, mixed>
Instance
$_oCloud  : object|null
Cloud_Model object
$_propertiesValues  : array<string|int, mixed>
Properties values
$_redirectUri  : mixed
Redirect uri
$_timeout  : array<string|int, mixed>
Timeout
$_token  : mixed
Token
$_unlimitedProperties  : bool
Object has unlimited number of properties
__construct()  : mixed
Constructor
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
delete()  : bool
Delete file from cloud
download()  : bool
Download file from cloud
downloadChunked()  : mixed
Download file from cloud
edit()  : bool
Edit
factory()  : object
Create and return an object
getAccessToken()  : string
Get access token
getBreadCrumbs()  : array<string|int, mixed>
Get breadcrumbs
getButtonClass()  : string
Get button class
getClouds()  : array<string|int, mixed>
Get clouds
getEditUrl()  : string
Get edit URL
getOauthCodeUrl()  : string
Get OAuth url
getToken()  : object
Get token
listDir()  : array<string|int, mixed>
Get directory list
set()  : self
Run when writing data to inaccessible properties
setUnlimitedProperties()  : self
Set unlimitedProperties
upload()  : bool|null
Prepare to uploading file into cloud
uploadChunked()  : bool
Prepare to uploading file into cloud
_getEntity()  : object|false
Get entity object

Properties

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array()

$_cache

listDir Cache

protected static array<string|int, mixed> $_cache = array()

$_config

Config

protected array<string|int, mixed> $_config = array()

$_instance

Instance

protected static array<string|int, mixed> $_instance = array()

$_oCloud

Cloud_Model object

protected object|null $_oCloud = \NULL

$_propertiesValues

Properties values

protected array<string|int, mixed> $_propertiesValues = array()

$_redirectUri

Redirect uri

protected mixed $_redirectUri = \NULL

$_timeout

Timeout

protected array<string|int, mixed> $_timeout = array()

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

Methods

addAllowedProperties()

Add additional allowed properties

public addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
$array : array<string|int, mixed>

array of properties' names

Return values
self

addAllowedProperty()

Add additional allowed property

public addAllowedProperty(string $property) : self
Parameters
$property : string

property name

Return values
self

delete()

Delete file from cloud

public delete(object $oObjectData) : bool
Parameters
$oObjectData : object

file object

Return values
bool

download()

Download file from cloud

public download(string $fileId, mixed $sTargetDir[, mixed $aParams = array() ]) : bool
Parameters
$fileId : string

file id

$sTargetDir : mixed
$aParams : mixed = array()

options, e.g. for export add 'mimeType' => 'application/pdf'

Return values
bool

downloadChunked()

Download file from cloud

public downloadChunked(string $fileId, mixed $sTargetDir) : mixed
Parameters
$fileId : string

file id

$sTargetDir : mixed
Return values
mixed

edit()

Edit

public edit() : bool
Return values
bool

factory()

Create and return an object

public static factory(int $iCloudId) : object
Parameters
$iCloudId : int

cloud id

Return values
object

getAccessToken()

Get access token

public getAccessToken([mixed $aValues = array() ]) : string
Parameters
$aValues : mixed = array()
Return values
string

getBreadCrumbs()

Get breadcrumbs

public getBreadCrumbs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getButtonClass()

Get button class

public getButtonClass() : string
Return values
string

getClouds()

Get clouds

public static getClouds() : array<string|int, mixed>
Return values
array<string|int, mixed>

getEditUrl()

Get edit URL

public getEditUrl(string $fileId, string $originalFilename) : string
Parameters
$fileId : string
$originalFilename : string
Return values
string

getOauthCodeUrl()

Get OAuth url

public getOauthCodeUrl() : string
Return values
string

getToken()

Get token

public getToken() : object
Return values
object

listDir()

Get directory list

public listDir() : array<string|int, mixed>
Return values
array<string|int, mixed>

set()

Run when writing data to inaccessible properties

public set(string $property, string $value) : self
Parameters
$property : string

property name

$value : string

property value

Return values
self

setUnlimitedProperties()

Set unlimitedProperties

public setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
$value : bool = TRUE

default TRUR

Return values
self

upload()

Prepare to uploading file into cloud

public upload(string $sSourcePath[, string $sDestinationFileName = NULL ][, array<string|int, mixed> $aParams = array() ]) : bool|null
Parameters
$sSourcePath : string

file name

$sDestinationFileName : string = NULL
$aParams : array<string|int, mixed> = array()

options, e.g. 'mimeType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'

Return values
bool|null

uploadChunked()

Prepare to uploading file into cloud

public uploadChunked(string $sSourcePath[, string $sDestinationFileName = NULL ][, array<string|int, mixed> $aParams = array() ]) : bool
Parameters
$sSourcePath : string

file name

$sDestinationFileName : string = NULL
$aParams : array<string|int, mixed> = array()

options, e.g. 'mimeType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'

Return values
bool

_getEntity()

Get entity object

protected _getEntity(string $sEntityId) : object|false
Parameters
$sEntityId : string

entity

Return values
object|false

Search results