class Set (View source)

Represents a file set.

Constants

TYPE_PRIVATE

TYPE_PUBLIC

TYPE_STARRED

TYPE_SAVED_SEARCH

GLOBAL_FILESET_USER_ID

Properties

protected $fileSetFiles
int $fsID
int $uID
string $fsName
int $fsType
$fsSearchRequest
$fsResultColumns

Methods

static 
getGlobal()

Returns an object mapping to the global file set, fsID = 0.

static Set[]
getMySets(bool|User|UserInfo $user = false)

Returns all sets currently available to the User

static array
getOwnedSets(bool|User|UserInfo $user = false)

Returns all sets (except saved searches) for a User

static mixed
createAndGetSet(string $fs_name, int $fs_type, int|bool $fs_uid = false)

Creats a new fileset if set doesn't exists.

static Set
getByID(int $fsID)

Get a file set object by a file set's id.

static 
__callStatic($name, $arguments)

No description

static Set
create(string $setName, int $fsOverrideGlobalPermissions, bool|User $u = false, int $type = self::TYPE_PUBLIC)

Adds a File set.

static array|void
getFilesBySetID(int $fsID)

Static method to return an array of File objects by the set id.

static array|void
getFilesBySetName(string $fsName, int|bool $uID = false)

Static method to return an array of File objects by the set name.

static Set
getByName(string $fsName, int|bool $uID = false)

Get a file set object by a file name.

File[]
getFiles()

Returns an array of File objects from the current set.

populateFiles()

Get a list of files associated with this set.

int
getFileSetUserID()

No description

int
getFileSetType()

No description

getSavedSearches()

No description

int
getFileSetID()

No description

updateFileSetDisplayOrder(array $files)

No description

int
overrideGlobalPermissions()

No description

string
getFileSetName()

No description

string
getFileSetDisplayName(string $format = 'html')

Returns the display name for this file set (localized and escaped accordingly to $format).

Set
update($setName)

Updates a file set.

File|null
addFileToSet(int|File|Version $f_id)

Adds the file to the set.

getSavedSearchRequest()

No description

getSavedSearchColumns()

No description

bool
removeFileFromSet(int|File|Version $f_id)

No description

hasFileID($f_id)

No description

delete()

No description

getJSONObject()

No description

getPermissionResponseClassName() deprecated

No description

getPermissionObjectKeyCategoryHandle() deprecated

No description

getPermissionObjectIdentifier() deprecated

No description

Details

static getGlobal()

Returns an object mapping to the global file set, fsID = 0.

This is really only used for permissions mapping.

static Set[] getMySets(bool|User|UserInfo $user = false)

Returns all sets currently available to the User

Parameters

bool|User|UserInfo $user

Return Value

Set[]

static array getOwnedSets(bool|User|UserInfo $user = false)

Returns all sets (except saved searches) for a User

Parameters

bool|User|UserInfo $user User or UserInfo Object

Return Value

array

static mixed createAndGetSet(string $fs_name, int $fs_type, int|bool $fs_uid = false)

Creats a new fileset if set doesn't exists.

If we find a multiple groups with the same properties, we return an array containing each group

Parameters

string $fs_name
int $fs_type
int|bool $fs_uid

Return Value

mixed Dev Note: This will create duplicate sets with the same name if a set exists owned by another user!!!

static Set getByID(int $fsID)

Get a file set object by a file set's id.

Parameters

int $fsID

Return Value

Set

static __callStatic($name, $arguments)

Parameters

$name
$arguments

static Set create(string $setName, int $fsOverrideGlobalPermissions, bool|User $u = false, int $type = self::TYPE_PUBLIC)

Adds a File set.

Parameters

string $setName
int $fsOverrideGlobalPermissions
bool|User $u
int $type

Return Value

Set

static array|void getFilesBySetID(int $fsID)

Static method to return an array of File objects by the set id.

Parameters

int $fsID

Return Value

array|void

static array|void getFilesBySetName(string $fsName, int|bool $uID = false)

Static method to return an array of File objects by the set name.

Parameters

string $fsName
int|bool $uID

Return Value

array|void

static Set getByName(string $fsName, int|bool $uID = false)

Get a file set object by a file name.

Parameters

string $fsName
int|bool $uID

Return Value

Set

File[] getFiles()

Returns an array of File objects from the current set.

Return Value

File[]

private populateFiles()

Get a list of files associated with this set.

Can obsolete this when we get version of ADOdB with one/many support

int getFileSetUserID()

Return Value

int

int getFileSetType()

Return Value

int

getSavedSearches()

int getFileSetID()

Return Value

int

updateFileSetDisplayOrder(array $files)

Parameters

array $files Array of file IDs

int overrideGlobalPermissions()

Return Value

int

string getFileSetName()

Return Value

string

string getFileSetDisplayName(string $format = 'html')

Returns the display name for this file set (localized and escaped accordingly to $format).

Parameters

string $format

Return Value

string

Set update($setName)

Updates a file set.

Parameters

$setName

Return Value

Set

File|null addFileToSet(int|File|Version $f_id)

Adds the file to the set.

Parameters

int|File|Version $f_id

Return Value

File|null returns NULL if the operation failed (for instance because $f_id is invalid), a \Concrete\Core\File\Set\File instance otherwise

getSavedSearchRequest()

getSavedSearchColumns()

bool removeFileFromSet(int|File|Version $f_id)

Parameters

int|File|Version $f_id

Return Value

bool Returns false if the operation failed (for instance because $f_id is invalid), true otherwise

hasFileID($f_id)

Parameters

$f_id

delete()

getJSONObject()

getPermissionResponseClassName() deprecated

deprecated

getPermissionObjectKeyCategoryHandle() deprecated

deprecated

getPermissionObjectIdentifier() deprecated

deprecated