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).
Details
in
Set at line 63
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 76
static array
getMySets(bool|User $u = false)
No description
in
Set at line 110
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 136
static Set
getByID(int $fsID)
Get a file set object by a file set's id.
in
Set at line 155
static
__callStatic($name, $arguments)
No description
in
Set at line 173
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 210
static array|void
getFilesBySetID(int $fsID)
Static method to return an array of File objects by the set id.
in
Set at line 228
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 246
static Set
getByName(string $fsName, int|bool $uID = false)
Get a file set object by a file name.
in
Set at line 267
File[]
getFiles()
Returns an array of File objects from the current set.
in
Set at line 285
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 293
int
getFileSetUserID()
No description
in
Set at line 301
int
getFileSetType()
No description
in
Set at line 306
getSavedSearches()
No description
in
Set at line 327
int
getFileSetID()
No description
in
Set at line 339
updateFileSetDisplayOrder(array $files)
No description
in
Set at line 358
int
overrideGlobalPermissions()
No description
in
Set at line 366
string
getFileSetName()
No description
in
Set at line 378
string
getFileSetDisplayName(string $format = 'html')
Returns the display name for this file set (localized and escaped accordingly to $format).
in
Set at line 395
Set
update($setName)
Updates a file set.
in
Set at line 414
File|mixed
addFileToSet(int|File $f_id)
Adds the file to the set.
in
Set at line 427
getSavedSearchRequest()
No description
in
Set at line 432
getSavedSearchColumns()
No description
in
Set at line 440
removeFileFromSet(int|File $f_id)
No description
in
Set at line 457
hasFileID($f_id)
No description
in
Set at line 469
delete()
No description
in
Set at line 540
getJSONObject()
No description
in
Set at line 553
getPermissionResponseClassName()
deprecated
deprecated
No description
in
Set at line 561
getPermissionObjectKeyCategoryHandle()
deprecated
deprecated
No description
in
Set at line 569
getPermissionObjectIdentifier()
deprecated
deprecated
No description