public
|
#
__construct( CApiGlobalManager & $oManager, $sForcedStorage = '' )
Parameters
- $oManager
- $oManager
- $sForcedStorage
|
public
CApiMinManager
|
|
public
boolean
|
#
isFileExists( CAccount $oAccount, integer $iType, string $sPath, string $sName )
Checks if file exists.
Parameters
- $oAccount
- Account object.
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sName
- Filename.
Returns
boolean
|
public
resource|boolean
|
#
getSharedFile( CAccount $oAccount, integer $iType, string $sPath, string $sName )
Allows for reading contents of the shared file. Aurora only.
Allows for reading contents of the shared file. Aurora only.
Parameters
- $oAccount
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sName
- Filename.
Returns
resource|boolean
|
public
CFileStorageItem
|
#
getFileInfo( CAccount $oAccount, integer $iType, string $sPath, string $sName )
Retrieves array of metadata on the specific file.
Retrieves array of metadata on the specific file.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sName
- Filename.
Returns
|
public
CFileStorageItem
|
#
getDirectoryInfo( CAccount $oAccount, integer $iType, string $sPath )
Retrieves array of metadata on the specific directory.
Retrieves array of metadata on the specific directory.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder.
Returns
|
public
resource|boolean
|
#
getFile( CAccount $oAccount, integer $iType, string $sPath, string $sName )
Allows for reading contents of the file.
Allows for reading contents of the file.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sName
- Filename.
Returns
resource|boolean
|
public
string|boolean
|
#
createPublicLink( CAccount $oAccount, integer $iType, string $sPath, string $sName, string $sSize, string $bIsFolder )
Creates public link for specific file or folder.
Creates public link for specific file or folder.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder.
- $sName
- Filename.
- $sSize
- Size information, it will be displayed when recipient opens the link.
- $bIsFolder
- If true, it is assumed the link is created for a folder, false otherwise.
Returns
string|boolean
|
public
boolean
|
#
deletePublicLink( CAccount $oAccount, integer $iType, string $sPath, string $sName )
Removes public link created for specific file or folder.
Removes public link created for specific file or folder.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder.
- $sName
- Filename.
Returns
boolean
|
public
array
|
#
getFiles( CAccount $oAccount, string $sType, string $sPath, string $sPattern = '' )
Performs search for files.
Performs search for files.
Parameters
- $oAccount
- Account object
- $sType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder.
- $sPattern
- Search string.
Returns
array
array of \CFileStorageItem.
|
public
boolean
|
#
createFolder( CAccount $oAccount, integer $iType, string $sPath, string $sFolderName )
Creates a new folder.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the parent folder, empty string means top-level folder is created.
- $sFolderName
- Folder name.
Returns
boolean
|
public
boolean
|
#
createFile( CAccount $oAccount, integer $iType, string $sPath, string $sFileName, $mData, boolean $bOverride = true )
Creates a new file.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is created in the root folder.
- $sFileName
- Filename.
- $mData
- to be stored in the file.
- $bOverride
- If true, existing file with that name will be overwritten.
Returns
boolean
|
public
boolean
|
#
createLink( CAccount $oAccount, integer $iType, string $sPath, string $sLink, string $sName )
Creates a link to arbitrary online content.
Creates a link to arbitrary online content.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the link.
- $sLink
- URL of the item to be linked.
- $sName
- Name of the link.
Returns
boolean
|
public
boolean
|
#
delete( CAccount $oAccount, integer $iType, string $sPath, string $sName )
Removes file or folder.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sName
- Filename.
Returns
boolean
|
public
boolean
|
#
rename( CAccount $oAccount, integer $iType, string $sPath, string $sName, string $sNewName, boolean $bIsLink )
Renames file or folder.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sName
- Name of file or folder.
- $sNewName
- New name.
- $bIsLink
Returns
boolean
|
public
boolean
|
#
move( CAccount $oAccount, integer $iFromType, integer $iToType, string $sFromPath, string $sToPath, string $sName, string $sNewName )
Move file or folder to a different location. In terms of Aurora, item can be moved to a different storage as well.
Move file or folder to a different location. In terms of Aurora, item can be moved to a different storage as well.
Parameters
- $oAccount
- Account object
- $iFromType
- Source storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $iToType
- Destination storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sFromPath
- Path to the folder which contains the item.
- $sToPath
- Destination path of the item.
- $sName
- Current name of file or folder.
- $sNewName
- New name of the item.
Returns
boolean
|
public
boolean
|
#
copy( CAccount $oAccount, integer $iFromType, integer $iToType, string $sFromPath, string $sToPath, string $sName, string $sNewName = null )
Copies file or folder, optionally renames it.
Copies file or folder, optionally renames it.
Parameters
- $oAccount
- Account object
- $iFromType
- Source storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $iToType
- Destination storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sFromPath
- Path to the folder which contains the item.
- $sToPath
- Destination path of the item.
- $sName
- Current name of file or folder.
- $sNewName
- New name of the item.
Returns
boolean
|
public
array
|
#
getRealQuota( CAccount $oAccount, string $sType = EFileStorageTypeStr::Personal )
Returns quota information for specific storage, used and available space.
Returns quota information for specific storage, used and available space.
Parameters
- $oAccount
- Account object
- $sType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
Returns
array
array( $iUsageSize, $iFreeSize );
|
public
array
|
#
getQuota( CAccount $oAccount )
Returns general quota information for the account, used and available space.
Returns general quota information for the account, used and available space.
Parameters
Returns
array
array( $iUsageSize, $iFreeSize );
|
public
string
|
#
getNonExistingFileName( CAccount $oAccount, integer $iType, string $sPath, string $sFileName )
Allows for obtaining filename which doesn't exist in current directory. For example, if you need to store data.txt file but it already exists, this method will return data_1.txt, or data_2.txt if that one already exists, and so on.
Allows for obtaining filename which doesn't exist in current directory. For example, if you need to store data.txt file but it already exists, this method will return data_1.txt, or data_2.txt if that one already exists, and so on.
Parameters
- $oAccount
- Account object
- $iType
- Storage type. Accepted values: EFileStorageType::Personal, EFileStorageType::Corporate, EFileStorageType::Shared.
- $sPath
- Path to the folder which contains the file, empty string means the file is in the root folder.
- $sFileName
- Filename.
Returns
string
|
public
|
|
public
|
|
public
|
|
CApiFilestorageManager