1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. SystemDMS
  7. \
  8. Hook
  9. \
  10. Webservice
  11. \
  12. ApiService

ApiService

class ApiService extends Service

Class ApiService

Properties

SystemDMSController $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
protected bool $isInternal from  Service

Methods

mixed
__call(string $name, array $arguments = [])

Checks if a callback is defined on the Method and calls it.

from  Service
array
createFileCopy(string $sourceUuid)

No description

static Method
createMethod(string $methodName)

Create new service method

from  Service
string
getHookDescription()

No description

from  BaseHook
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
string
getHookTitle()

No description

from  BaseHook
string
getJsonRpcResponse(array|object $data, int $requestId = null)

No description

from  Service
Method|null
getMethod(string $name)

Get Service Method

from  Service
callable|null
getMethodCallback(string $name)

Returns the callback of a method if it is defined.

from  Service
getObject()

No description

from  BaseHook
mixed
getOption(string $key)

Returns the option with $key set in the config.yml

from  BaseHook
get_service_description()

Returns the registered webservice methods.

from  Service
string
handleFileUpload()

Handle the file upload using PUT request method

init()

Initialization after construction with access to $this->mod

from  Service
array
initFileUpload(string $fileTypeExtension, int $fileSizeBytes, string $fileName, string|null $fileHashMD5 = null)

No description

bool
isAvailable()

Returns true if this hook is available otherwise false.

from  Service
bool
isInternal()

No description

from  Service
array
readCategoryDocumentCollection(string $uuid, array|null $XQL = [])

No description

Method
readDocumentIndexCollectionSetup()

No description

array
readDocumentInfo(string $uuid, bool $scopeExtendedInfo = false, bool $scopeFullInfo = false)

Read information about a file attachment (dms document)

array
readFileUploadStatus(string $uploadToken)

No description

array
setupMethods()

No description

array
updateFile($uuid, $thumbnailUuid = null)

No description

Details

in Service at line 127
mixed __call(string $name, array $arguments = [])

Checks if a callback is defined on the Method and calls it.

Parameters

string $name
array $arguments

Return Value

mixed

Exceptions

RuntimeException

See also

Method::setCallback

at line 320
array createFileCopy(string $sourceUuid)

No description

Parameters

string $sourceUuid

Return Value

array

Exceptions

Exception

in Service at line 238
static protected Method createMethod(string $methodName)

Create new service method

Parameters

string $methodName

Return Value

Method

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

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()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

in Service at line 222
string getJsonRpcResponse(array|object $data, int $requestId = null)

No description

Parameters

array|object $data
int $requestId

Return Value

string

in Service at line 154
Method|null getMethod(string $name)

Get Service Method

Parameters

string $name

Return Value

Method|null

in Service at line 143
callable|null getMethodCallback(string $name)

Returns the callback of a method if it is defined.

Parameters

string $name

Method name

Return Value

callable|null

in BaseHook at line 88
getObject()

No description

in BaseHook at line 97
mixed getOption(string $key)

Returns the option with $key set in the config.yml

Parameters

string $key

Return Value

mixed

in Service at line 182
get_service_description()

Returns the registered webservice methods.

See also

setupMethods Please use setupMethods to define and return your webservice methods.

Examples

[
  'hello' => [
     'input'  => ['name'     => 'string],
     'output' => ['greeting' => 'string],
]

at line 365
string handleFileUpload()

Handle the file upload using PUT request method

Return Value

string

Exceptions

Exception

in Service at line 167
init()

Initialization after construction with access to $this->mod

at line 154
array initFileUpload(string $fileTypeExtension, int $fileSizeBytes, string $fileName, string|null $fileHashMD5 = null)

No description

Parameters

string $fileTypeExtension

e.g. xls
int $fileSizeBytes

e.g. 1024
string $fileName
string|null $fileHashMD5

Return Value

array

in Service at line 213
bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool

in Service at line 245
bool isInternal()

No description

Return Value

bool

at line 499
array readCategoryDocumentCollection(string $uuid, array|null $XQL = [])

No description

Parameters

string $uuid
array|null $XQL

Return Value

array

at line 540
Method readDocumentIndexCollectionSetup()

No description

Return Value

Method

at line 232
array readDocumentInfo(string $uuid, bool $scopeExtendedInfo = false, bool $scopeFullInfo = false)

Read information about a file attachment (dms document)

Information is returned as MagicDocumentHelper

Parameters

string $uuid
bool $scopeExtendedInfo
bool $scopeFullInfo

Return Value

array

Exceptions

Exception

at line 269
array readFileUploadStatus(string $uploadToken)

No description

Parameters

string $uploadToken

Return Value

array

at line 35
array setupMethods()

No description

Return Value

array

at line 81
array updateFile($uuid, $thumbnailUuid = null)

No description

Parameters

$uuid
$thumbnailUuid

Return Value

array