StorageProvider
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
Initialize and executes the download of a selected remote file.
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
Returns the account free storage quota in bytes.
Returns size in bytes of total space of the storage.
Returns size in bytes of used space of the storage.
Returns the account used storage quota in percent.
Returns an instance of StorageContent that contains all files requested by the given path which is provider specific
Returns the xelos icon class name which presents the provider storage service.
Returns a name identifier of the provider storage service.
Returns the title of the provider storage service.
No description
This method is used to initialize the providers connection by oauth clients.
Returns true if the provider is connected.
Returns an array which contains the content of the requested path. This array is used by xui_tree.
Download the requested remote file and save the content to the destination path.
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.
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
BaseHook at line 88
getObject()
No description
at line 122
int
get_account_quota_free()
Returns the account free storage quota in bytes.
at line 52
abstract int
get_account_quota_total()
Returns size in bytes of total space of the storage.
at line 59
abstract int
get_account_quota_used()
Returns size in bytes of used space of the storage.
at line 131
int
get_account_quota_used_percent()
Returns the account used storage quota in percent.
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
.
at line 45
abstract string
get_icon_class_name()
Returns the xelos icon class name which presents the provider storage service.
at line 37
abstract string
get_provider_name()
Returns a name identifier of the provider storage service.
at line 30
abstract string
get_provider_title()
Returns the title of the provider storage service.
at line 113
bool
hideWhenDisconnected()
No description
at line 23
abstract
init_provider()
This method is used to initialize the providers connection by oauth clients.
in
BaseHook at line 97
abstract bool
isAvailable()
Returns true if this hook is available otherwise false.
at line 66
abstract bool
is_connected()
Returns true if the provider is connected.
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.
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.
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.