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 $u = false)

No description

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 69
static getGlobal()

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

This is really only used for permissions mapping.

at line 82
static Set[] getMySets(bool|User $u = false)

No description

Parameters

bool|User $u

Return Value

Set[]

at line 116
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 142
static Set getByID(int $fsID)

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

Parameters

int $fsID

Return Value

Set

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

No description

Parameters

$name
$arguments

at line 179
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 216
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 234
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 252
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 273
File[] getFiles()

Returns an array of File objects from the current set.

Return Value

File[]

at line 291
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 299
int getFileSetUserID()

No description

Return Value

int

at line 307
int getFileSetType()

No description

Return Value

int

at line 312
getSavedSearches()

No description

at line 333
int getFileSetID()

No description

Return Value

int

at line 345
updateFileSetDisplayOrder(array $files)

No description

Parameters

array $files

Array of file IDs

at line 364
int overrideGlobalPermissions()

No description

Return Value

int

at line 372
string getFileSetName()

No description

Return Value

string

at line 384
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 401
Set update($setName)

Updates a file set.

Parameters

$setName

Return Value

Set

at line 420
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 455
getSavedSearchRequest()

No description

at line 460
getSavedSearchColumns()

No description

at line 470
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 510
hasFileID($f_id)

No description

Parameters

$f_id

at line 522
delete()

No description

at line 598
getJSONObject()

No description

at line 611
getPermissionResponseClassName() deprecated

deprecated

No description

at line 619
getPermissionObjectKeyCategoryHandle() deprecated

deprecated

No description

at line 627
getPermissionObjectIdentifier() deprecated

deprecated

No description

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