Contentserv PHP API

CSMamVolume
in package

Defines a volume in the CONTENTSERV MAM-Suite

Tags
access

public

since
5.0

Table of Contents

$mamVolume  : mixed
__call()  : mixed
Call functions that are not defined in this class, but in the MamVolume.
__construct()  : mixed
delete()  : void
Deletes the current CSMamVolume
getID()  : int
Returns the ID of the CSMamVolume
getLastSyncTime()  : int
Returns the unix timestamp the volume as been synchronized last
getName()  : string
Gets the name of a CSMamVolume
getRootFolder()  : CSMamFile
Returns the CSMamFile representing the root folder of the CSMamVolume
getSyncFrequency()  : int
Returns the frequency in minutes the volume is synchronized within an automation
getValue()  : string
Gets a value of a CSMamVolume
isWritable()  : bool
Returns whether files can be modified within this volume
setName()  : void
Sets the name of the CSMamVolume
setSyncFrequency()  : void
Sets the frequency in minutes the volume should synchronized within an automation. If set to 0 it will never be synchronized
setValue()  : void
Sets a value of the CSMamVolume
setWritable()  : void
Sets whether files can be modified within this volume
store()  : int
Stores the volume to the database and returns the new ID on success
synchronize()  : array<string|int, mixed>
Synchronizes all files from a remote system with the current CONTENTSERV installation Sometimes a extended synchronisation is required, e.g. when the local version files have been deleted, e.g. by installing a backup on a other system. For this reason the $forceCompleteCheck flag has been added.

Properties

$mamVolume

public mixed $mamVolume
Tags
access

private

Methods

__call()

Call functions that are not defined in this class, but in the MamVolume.

public __call(string $name, array<string|int, mixed> $params) : mixed
Parameters
$name : string

Name of the function called, e.g. 'clearCache'

$params : array<string|int, mixed>

Parameters that have been supplied to the function call

Tags
Return values
mixed —

false if function doesn't exist in driver or else the return value of the function from the driver implementation

__construct()

public __construct([mixed $ID = null ]) : mixed
Parameters
$ID : mixed = null
Tags
access

private

Return values
mixed —

delete()

Deletes the current CSMamVolume

public delete() : void
Tags
access

public

Return values
void —

getID()

Returns the ID of the CSMamVolume

public getID() : int
Tags
access

public

Return values
int —

the ID of the field

getLastSyncTime()

Returns the unix timestamp the volume as been synchronized last

public getLastSyncTime() : int
Tags
access

public

Return values
int —

the timestamp of the last synchronization

getName()

Gets the name of a CSMamVolume

public getName() : string
Tags
access

public

Return values
string —

the name

getRootFolder()

Returns the CSMamFile representing the root folder of the CSMamVolume

public getRootFolder() : CSMamFile
Tags
access

public

Return values
CSMamFile —

getSyncFrequency()

Returns the frequency in minutes the volume is synchronized within an automation

public getSyncFrequency() : int
Tags
access

public

Return values
int —

the frequency in minutes

getValue()

Gets a value of a CSMamVolume

public getValue(string $name) : string
Parameters
$name : string

name of the value to get

Tags
access

public

Return values
string —

the value

isWritable()

Returns whether files can be modified within this volume

public isWritable() : bool
Tags
access

public

Return values
bool —

whether one can write within the current volume

setName()

Sets the name of the CSMamVolume

public setName(string $name) : void
Parameters
$name : string

name to set

Tags
access

public

Return values
void —

setSyncFrequency()

Sets the frequency in minutes the volume should synchronized within an automation. If set to 0 it will never be synchronized

public setSyncFrequency(int $newFrequency) : void
Parameters
$newFrequency : int

the new frequency in minutes

Tags
access

public

Return values
void —

setValue()

Sets a value of the CSMamVolume

public setValue(string $name, string $value) : void
Parameters
$name : string

name of the value to set

$value : string

value to set

Tags
access

public

Return values
void —

setWritable()

Sets whether files can be modified within this volume

public setWritable([boolen $isWritable = true ]) : void
Parameters
$isWritable : boolen = true

whether the volume should be writable or not

Tags
access

public

Return values
void —

store()

Stores the volume to the database and returns the new ID on success

public store() : int
Tags
access

public

Return values
int —

the ID of the CSMamVolume

synchronize()

Synchronizes all files from a remote system with the current CONTENTSERV installation Sometimes a extended synchronisation is required, e.g. when the local version files have been deleted, e.g. by installing a backup on a other system. For this reason the $forceCompleteCheck flag has been added.

public synchronize([bool $forceCompleteCheck = false ]) : array<string|int, mixed>

If this flag is set the details of all files are transfered. Therefore this action may require a long time to synchronize

Parameters
$forceCompleteCheck : bool = false

whether all files should be explicitly compared or only the changed ones

Tags
access

public

Return values
array<string|int, mixed> —

of arrays containing the changed ids, with a group as key (new, created, deleted, changed, syncstatechanged) and the related ids as values


        

        
    




    

    

                

    

        

            
Search results