abstract class StorageProvider extends BaseHook

Class StorageProvider

Properties

Controller $mod
array $_hook_info Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => "" from BaseHook

Methods

bool
do_download(string $cloud_source_path, string $destination_dir_path)

Initialize and executes the download of a selected remote file.

string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, .

from BaseHook
string
getHookInstance()

No description

from BaseHook
string
getHookName()

No description

from BaseHook
int
get_account_quota_free()

Returns the account free storage quota in bytes.

int
get_account_quota_total()

Returns size in bytes of total space of the storage.

int
get_account_quota_used()

Returns size in bytes of used space of the storage.

int
get_account_quota_used_percent()

Returns the account used storage quota in percent.

get_content(string $path)

Returns an instance of StorageContent that contains all files requested by the given path which is provider specific

string
get_icon_class_name()

Returns the xelos icon class name which presents the provider storage service.

string
get_provider_name()

Returns a name identifier of the provider storage service.

string
get_provider_title()

Returns the title of the provider storage service.

bool
hideWhenDisconnected()

No description

init_provider()

This method is used to initialize the providers connection by oauth clients.

bool
isAvailable()

Returns true if this hook is available otherwise false.

from BaseHook
bool
is_connected()

Returns true if the provider is connected.

array
on_browse_tree(string $path = null) deprecated

Returns an array which contains the content of the requested path. This array is used by xui_tree.

on_download(string $cloud_source_path, string $destination_dir_path)

Download the requested remote file and save the content to the destination path.

on_upload(string $cloud_path, string $fileName, resource $fileStream)

Executes the provider specific file upload from xelos to the remote storage space.

Details

at line 146
bool do_download(string $cloud_source_path, string $destination_dir_path)

Initialize and executes the download of a selected remote file.

Parameters

string $cloud_source_path
string $destination_dir_path

Return Value

bool

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, .

..)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

Return Value

string

in BaseHook at line 62
string getHookName()

Return Value

string

at line 122
int get_account_quota_free()

Returns the account free storage quota in bytes.

Return Value

int

at line 52
abstract int get_account_quota_total()

Returns size in bytes of total space of the storage.

Return Value

int

at line 59
abstract int get_account_quota_used()

Returns size in bytes of used space of the storage.

Return Value

int

at line 131
int get_account_quota_used_percent()

Returns the account used storage quota in percent.

Return Value

int

at line 77
abstract StorageContent get_content(string $path)

Returns an instance of StorageContent that contains all files requested by the given path which is provider specific

.

Parameters

string $path A provider specific remote file path.

Return Value

StorageContent

at line 45
abstract string get_icon_class_name()

Returns the xelos icon class name which presents the provider storage service.

Return Value

string

at line 37
abstract string get_provider_name()

Returns a name identifier of the provider storage service.

Return Value

string

at line 30
abstract string get_provider_title()

Returns the title of the provider storage service.

Return Value

string

at line 113
bool hideWhenDisconnected()

Return Value

bool

at line 23
abstract init_provider()

This method is used to initialize the providers connection by oauth clients.

in BaseHook at line 78
abstract bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool

at line 66
abstract bool is_connected()

Returns true if the provider is connected.

Return Value

bool

at line 89
abstract array on_browse_tree(string $path = null) deprecated

deprecated

Returns an array which contains the content of the requested path. This array is used by xui_tree.

Parameters

string $path A provider specific remote file path.

Return Value

array

at line 108
abstract protected on_download(string $cloud_source_path, string $destination_dir_path)

Download the requested remote file and save the content to the destination path.

Parameters

string $cloud_source_path
string $destination_dir_path

at line 99
abstract on_upload(string $cloud_path, string $fileName, resource $fileStream)

Executes the provider specific file upload from xelos to the remote storage space.

Parameters

string $cloud_path
string $fileName
resource $fileStream