1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. File
  7. \
  8. Set
  9. \
  10. Set

Set

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 = 0, 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

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

Deprecated method. Use Set::create instead.

Details

at line 70
static getGlobal()

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

This is really only used for permissions mapping.

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

Returns all sets currently available to the User

Parameters

bool|User|UserInfo $user

Return Value

Set[]

at line 124
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

at line 167
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!!!

at line 193
static Set getByID(int $fsID)

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

Parameters

int $fsID

Return Value

Set

at line 212
static __callStatic($name, $arguments)

No description

Parameters

$name
$arguments

at line 230
static Set create(string $setName, int $fsOverrideGlobalPermissions = 0, 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

at line 267
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

at line 285
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

at line 303
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

at line 324
File[] getFiles()

Returns an array of File objects from the current set.

Return Value

File[]

at line 342
private populateFiles()

Get a list of files associated with this set.

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

at line 350
int getFileSetUserID()

No description

Return Value

int

at line 358
int getFileSetType()

No description

Return Value

int

at line 363
getSavedSearches()

No description

at line 384
int getFileSetID()

No description

Return Value

int

at line 396
updateFileSetDisplayOrder(array $files)

No description

Parameters

array $files

Array of file IDs

at line 415
int overrideGlobalPermissions()

No description

Return Value

int

at line 423
string getFileSetName()

No description

Return Value

string

at line 435
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

at line 452
Set update($setName)

Updates a file set.

Parameters

$setName

Return Value

Set

at line 471
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

at line 506
getSavedSearchRequest()

No description

at line 511
getSavedSearchColumns()

No description

at line 521
bool removeFileFromSet(int|File|Version $f_id)

No description

Parameters

int|File|Version $f_id

Return Value

bool

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

at line 561
hasFileID($f_id)

No description

Parameters

$f_id

at line 573
delete()

No description

at line 649
getJSONObject()

No description

at line 662
getPermissionResponseClassName() deprecated

deprecated

No description

at line 670
getPermissionObjectKeyCategoryHandle() deprecated

deprecated

No description

at line 678
getPermissionObjectIdentifier() deprecated

deprecated

No description

at line 28
static Set add(string $setName, int $fsOverrideGlobalPermissions, User $u = false, int $type = self::TYPE_PUBLIC)

Deprecated method. Use Set::create instead.

Parameters

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

Return Value

Set