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
Returns an object mapping to the global file set, fsID = 0.
No description
Creats a new fileset if set doesn't exists.
No description
Adds a File set.
Static method to return an array of File objects by the set id.
Static method to return an array of File objects by the set name.
Returns an array of File objects from the current set.
Get a list of files associated with this set.
No description
No description
No description
No description
No description
No description
No description
Returns the display name for this file set (localized and escaped accordingly to $format).
Adds the file to the set.
No description
No description
No description
No description
No description
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 array
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.
If we find a multiple groups with the same properties, we return an array containing each group
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.
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()
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|mixed
addFileToSet(int|File $f_id)
Adds the file to the set.
getSavedSearchRequest()
No description
getSavedSearchColumns()
No description
removeFileFromSet(int|File $f_id)
No description
hasFileID($f_id)
No description
delete()
No description
getJSONObject()
No description
getPermissionResponseClassName()
deprecated
deprecated
No description
getPermissionObjectKeyCategoryHandle()
deprecated
deprecated
No description
getPermissionObjectIdentifier()
deprecated
deprecated
No description
static Set
add(string $setName, int $fsOverrideGlobalPermissions, User $u = false, int $type = self::TYPE_PUBLIC)
Deprecated method. Use Set::create instead.