PHP Class OCA\Richdocuments\File

Show file Open project: owncloud/richdocuments Class Usage Examples

Protected Properties

Property Type Description
$fileId
$owner
$ownerView
$ownerViewFiles
$passwordProtected
$path
$pathFiles
$sharing
$token

Public Methods

Method Description
__construct ( $fileId, $shareOps = null, $token = '' )
checkPassword ( string $password ) : boolean
getByShareToken ( $token )
getFileId ( )
getOwner ( )
getOwnerView ( $relativeToFiles = false )
getPath ( $relativeToFiles = false )
getPermissions ( )
getToken ( )
isPasswordProtected ( )
isPublicShare ( )
setPasswordProtected ( boolean $value )
setToken ( $token )

Protected Methods

Method Description
getPassword ( )
initViews ( )

Method Details

__construct() public method

public __construct ( $fileId, $shareOps = null, $token = '' )

checkPassword() public method

public checkPassword ( string $password ) : boolean
$password string
return boolean

getByShareToken() public static method

public static getByShareToken ( $token )

getFileId() public method

public getFileId ( )

getOwner() public method

public getOwner ( )

getOwnerView() public method

public getOwnerView ( $relativeToFiles = false )

getPassword() protected method

protected getPassword ( )

getPath() public method

public getPath ( $relativeToFiles = false )

getPermissions() public method

public getPermissions ( )

getToken() public method

public getToken ( )

initViews() protected method

protected initViews ( )

isPasswordProtected() public method

public isPasswordProtected ( )

isPublicShare() public method

public isPublicShare ( )

setPasswordProtected() public method

public setPasswordProtected ( boolean $value )
$value boolean

setToken() public method

public setToken ( $token )

Property Details

$fileId protected property

protected $fileId

$owner protected property

protected $owner

$ownerView protected property

protected $ownerView

$ownerViewFiles protected property

protected $ownerViewFiles

$passwordProtected protected property

protected $passwordProtected

$path protected property

protected $path

$pathFiles protected property

protected $pathFiles

$sharing protected property

protected $sharing

$token protected property

protected $token