SavedSearch
class SavedSearch extends Set (View source)
Constants
| TYPE_PRIVATE |
|
| TYPE_PUBLIC |
|
| TYPE_STARRED |
|
| TYPE_SAVED_SEARCH |
|
| GLOBAL_FILESET_USER_ID |
|
Properties
| protected | $fileSetFiles | from Set | |
| int | $fsID | from Set | |
| int | $uID | from Set | |
| string | $fsName | from Set | |
| int | $fsType | from Set | |
| $fsSearchRequest | from Set | ||
| $fsResultColumns | from Set |
Methods
Creats a new fileset if set doesn't exists.
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.
Get a file set object by a file name.
Returns the display name for this file set (localized and escaped accordingly to $format).
Check if we should build the thumbnails for files added or removed to this file set should.
Details
in
Set at line 71
static
getGlobal()
Returns an object mapping to the global file set, fsID = 0.
This is really only used for permissions mapping.
in
Set at line 86
static Set[]
getMySets(bool|User|UserInfo $user = false)
Returns all sets currently available to the User
in
Set at line 125
static array
getOwnedSets(bool|User|UserInfo $user = false)
Returns all sets (except saved searches) for a User
in
Set at line 168
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
in
Set at line 195
static Set
getByID(int $fsID)
Get a file set object by a file set's id.
in
Set at line 214
static
__callStatic($name, $arguments)
No description
in
Set at line 232
static Set
create(string $setName, int $fsOverrideGlobalPermissions = 0, bool|User $u = false, int $type = self::TYPE_PUBLIC)
Adds a File set.
in
Set at line 269
static array|void
getFilesBySetID(int $fsID)
Static method to return an array of File objects by the set id.
in
Set at line 287
static array|void
getFilesBySetName(string $fsName, int|bool $uID = false)
Static method to return an array of File objects by the set name.
in
Set at line 305
static Set
getByName(string $fsName, int|bool $uID = false)
Get a file set object by a file name.
in
Set at line 326
File[]
getFiles()
Returns an array of File objects from the current set.
in
Set at line 344
private
populateFiles()
Get a list of files associated with this set.
Can obsolete this when we get version of ADOdB with one/many support
in
Set at line 352
int
getFileSetUserID()
No description
in
Set at line 360
int
getFileSetType()
No description
in
Set at line 365
getSavedSearches()
No description
in
Set at line 387
int
getFileSetID()
No description
in
Set at line 399
updateFileSetDisplayOrder(array $files)
No description
in
Set at line 418
int
overrideGlobalPermissions()
No description
in
Set at line 426
string
getFileSetName()
No description
in
Set at line 438
string
getFileSetDisplayName(string $format = 'html')
Returns the display name for this file set (localized and escaped accordingly to $format).
in
Set at line 455
Set
update($setName)
Updates a file set.
in
Set at line 474
File|null
addFileToSet(int|File|Version $f_id)
Adds the file to the set.
in
Set at line 509
getSavedSearchRequest()
No description
in
Set at line 514
getSavedSearchColumns()
No description
in
Set at line 524
bool
removeFileFromSet(int|File|Version $f_id)
No description
in
Set at line 564
hasFileID($f_id)
No description
in
Set at line 576
delete()
No description
in
Set at line 652
getJSONObject()
No description
in
Set at line 665
getPermissionResponseClassName()
deprecated
deprecated
No description
in
Set at line 673
getPermissionObjectKeyCategoryHandle()
deprecated
deprecated
No description
in
Set at line 681
getPermissionObjectIdentifier()
deprecated
deprecated
No description
in
Set at line 693
protected bool
shouldRefreshFileThumbnails(string $fileOperation)
Check if we should build the thumbnails for files added or removed to this file set should.