Documentation

Drive
in package

OcisPhpSdk

Class representing a single drive/space in ownCloud Infinite Scale

Methods

createFolder() : bool
delete() : void: Deletes the current drive irreversibly.
deletePermission() : bool: Permanently delete the current drive share $permissionId will be provided by getPermissionId()
deleteResource() : bool: Delete (move to trash-bin) the Ocis resource (file or folder) at the given path in the current drive
disable() : void: Disables the current drive without deleting it.
emptyTrashbin() : bool: Empty the trash-bin of the current drive. ALL FILES AND FOLDERS IN THE TRASH-BIN WILL BE DELETED! THIS ACTION CANNOT BE REVERTED!
enable() : void: Enables the current drive.
getAlias() : string
getFile() : callable|resource|string: Download and return the content of the file at the given path in the current drive
getFileStream() : resource: Return a stream resource for the file at the given path in the current drive.
getId() : string
getLastModifiedDateTime() : DateTime
getName() : string
getPermissions() : array<string|int, Permission>: get all permission assigned on drive
getQuota() : Quota
getRawData() : mixed
getResource() : OcisResource: get a specific resource in the current drive
getResourceMetadataById() : stdClass
getResources() : array<string|int, OcisResource>: List the content of a specific path in the current drive
getRoles() : array<string|int, SharingRole>: Gets all possible roles for the drive ( Project drive )
getRoot() : DriveItem|null
getType() : DriveType
getWebDavUrl() : string
getWebUrl() : string
invite() : Permission: Invite a user or group to the drive.
isDisabled() : bool
moveResource() : bool: Move or rename an Ocis resource in the current drive
setDescription() : Drive
setImage() : Drive
setName() : Drive
setPermissionExpiration() : bool: Change the Expiration date for the current drive share Set to null to remove the expiration date
setPermissionRole() : bool: Change the Role of the particular Drive Share.
setQuota() : Drive
setReadme() : Drive
tagResource() : void
untagResource() : void
uploadFile() : bool: Upload the given content to a specific path in the current drive
uploadFileStream() : bool: Stream the given resource to a specific path in the current drive

createFolder()


    public
                    createFolder(string $path) : bool

Parameters

$path : string

Return values

bool

delete()

Deletes the current drive irreversibly.


    public
                    delete() : void

A drive can only be deleted if it has already been disabled. Calling this function on a drive that is not disabled will have no effect. Only project spaces can be deleted.

deletePermission()

Permanently delete the current drive share $permissionId will be provided by getPermissionId()


    public
                    deletePermission(string $permissionId) : bool

Parameters

$permissionId : string

Return values

bool

deleteResource()

Delete (move to trash-bin) the Ocis resource (file or folder) at the given path in the current drive


    public
                    deleteResource(string $path) : bool

Parameters

$path : string

Return values

bool

disable()

Disables the current drive without deleting it.


    public
                    disable() : void

Disabling a drive is the prerequisite for deleting it. Calling this function on a drive that is already disabled will have no effect. Only project spaces can be disabled.

emptyTrashbin()

Empty the trash-bin of the current drive. ALL FILES AND FOLDERS IN THE TRASH-BIN WILL BE DELETED! THIS ACTION CANNOT BE REVERTED!


    public
                    emptyTrashbin() : bool

Return values

bool

enable()

Enables the current drive.


    public
                    enable() : void

Calling this function on a drive that is already enabled will have no effect. Only project spaces can be enabled.

getAlias()


    public
                    getAlias() : string

Return values

string

getFile()

Download and return the content of the file at the given path in the current drive


    public
                    getFile(string $path) : callable|resource|string

Parameters

$path : string

Return values

callable|resource|string

getFileStream()

Return a stream resource for the file at the given path in the current drive.


    public
                    getFileStream(string $path) : resource

The content of the file can be read from the stream.

Parameters

$path : string

Return values

resource

getId()


    public
                    getId() : string

Return values

string

getLastModifiedDateTime()


    public
                    getLastModifiedDateTime() : DateTime

Return values

DateTime

getName()


    public
                    getName() : string

Return values

string

getPermissions()

get all permission assigned on drive


    public
                    getPermissions() : array<string|int, Permission>

Return values

array<string|int, Permission>

getQuota()


    public
                    getQuota() : Quota

Return values

Quota

getRawData()


    public
                    getRawData() : mixed

getResource()

get a specific resource in the current drive


    public
                    getResource([string $path = "/" ]) : OcisResource

Parameters

$path : string = "/"

Return values

OcisResource

getResourceMetadataById()


    public
                    getResourceMetadataById(string $id) : stdClass

Parameters

$id : string

Return values

stdClass

getResources()

List the content of a specific path in the current drive


    public
                    getResources([string $path = "/" ]) : array<string|int, OcisResource>

Parameters

$path : string = "/"

Return values

array<string|int, OcisResource>

getRoles()

Gets all possible roles for the drive ( Project drive )


    public
                    getRoles() : array<string|int, SharingRole>

Return values

array<string|int, SharingRole>

getRoot()


    public
                    getRoot() : DriveItem|null

Return values

DriveItem|null

getType()


    public
                    getType() : DriveType

Return values

DriveType

getWebDavUrl()


    public
                    getWebDavUrl() : string

Return values

string

getWebUrl()


    public
                    getWebUrl() : string

Return values

string

invite()

Invite a user or group to the drive.


    public
                    invite(User|Group $recipient, SharingRole $role[, DateTimeImmutable|null $expiration = null ]) : Permission

Parameters

$recipient : User|Group
$role : SharingRole
$expiration : DateTimeImmutable|null = null

Return values

Permission

isDisabled()


    public
                    isDisabled() : bool

Return values

bool

moveResource()

Move or rename an Ocis resource in the current drive


    public
                    moveResource(string $sourcePath, string $destinationPath) : bool

Parameters

$sourcePath : string
$destinationPath : string

Return values

bool

setDescription()


    public
                    setDescription(string $description) : Drive

Parameters

$description : string

Return values

Drive

setImage()


    public
                    setImage(object $image) : Drive

Parameters

$image : object

Return values

Drive

setName()


    public
                    setName(string $name) : Drive

Parameters

$name : string

Return values

Drive

setPermissionExpiration()

Change the Expiration date for the current drive share Set to null to remove the expiration date


    public
                    setPermissionExpiration(string $permissionId, DateTimeImmutable|null $expiration) : bool

Parameters

$permissionId : string
$expiration : DateTimeImmutable|null

Return values

bool

setPermissionRole()

Change the Role of the particular Drive Share.


    public
                    setPermissionRole(string $permissionId, SharingRole $role) : bool

Possible roles are defined by the drive and have to be queried using Drive::getRoles() Roles for shares are not to be confused with the types of share links!

Parameters

$permissionId : string
$role : SharingRole

Return values

bool

setQuota()


    public
                    setQuota(int $quota) : Drive

Parameters

$quota : int

Return values

Drive

setReadme()


    public
                    setReadme(string $readme) : Drive

Parameters

$readme : string

Return values

Drive

tagResource()


    public
                    tagResource(string $path, array<string|int, string> $tags) : void

Parameters

$path : string
$tags : array<string|int, string>

untagResource()


    public
                    untagResource(string $path, array<string|int, string> $tags) : void

Parameters

$path : string
$tags : array<string|int, string>

uploadFile()

Upload the given content to a specific path in the current drive


    public
                    uploadFile(string $path, string $content) : bool

Parameters

$path : string
$content : string

Return values

bool

uploadFileStream()

Stream the given resource to a specific path in the current drive


    public
                    uploadFileStream(string $path, resource|string|null $resource) : bool

Parameters

$path : string
$resource : resource|string|null: File resource pointing to the file to be uploaded

Return values

bool

Drive in package OcisPhpSdk

Table of Contents

Methods

Methods

createFolder()

Parameters

Tags

Return values

delete()

Tags

deletePermission()

Parameters

Tags

Return values

deleteResource()

Parameters

Tags

Return values

disable()

Tags

emptyTrashbin()

Tags

Return values

enable()

Tags

getAlias()

Return values

getFile()

Parameters

Tags

Return values

getFileStream()

Parameters

Tags

Return values

getId()

Return values

getLastModifiedDateTime()

Tags

Return values

getName()

Return values

getPermissions()

Tags

Return values

getQuota()

Tags

Return values

getRawData()

getResource()

Parameters

Return values

getResourceMetadataById()

Parameters

Tags

Return values

getResources()

Parameters

Tags

Return values

getRoles()

Tags

Return values

getRoot()

Return values

getType()

Tags

Return values

getWebDavUrl()

Return values

getWebUrl()

Return values

invite()

Parameters

Tags

Return values

isDisabled()

Tags

Return values

moveResource()

Drive
in package

OcisPhpSdk