Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
BriefcaseFolder Class Reference
Inheritance diagram for BriefcaseFolder:
TreeFolder

Public Member Functions

 __construct ($db, $user_id, $type_id, $archive=false, $folder_id=null)
 getSubFolders ($folder_id)
 getFiles ($folder_id)

Data Fields

const ARTICLE = 1
const SEARCH = 2
const DOCUMENT = 3
const LOCATION = 4
const SHARED_ITEM = 5

Protected Attributes

 $user
 $archive = false
 $folder_id = null

Constructor & Destructor Documentation

__construct ( db,
user_id,
type_id,
archive = false,
folder_id = null 
)

Constructs the object

Parameters:
mMysql$dbA database connection (used to read the folder's subfolders and items)
string$user_idThe user identifier
string$nameThe name of the folder
int$type_idThe type identifier
boolean$archiveIf set to true, display a folder from the archive [OPTIONAL]
int$folder_idIf set, display only this folder [OPTIONAL] public
Returns:
void

Member Function Documentation

getFiles ( folder_id)

Returns the files of the current folder as an associative array

Parameters:
int$folder_idThe folder identifier public
Returns:
array|boolean

Reimplemented from TreeFolder.

getSubFolders ( folder_id)

Returns the subfolders of the current folder as an associative array with all the subfolders

Parameters:
int$folder_idThe folder identifier public
Returns:
array|boolean

Reimplemented from TreeFolder.


Field Documentation

$archive = false [protected]
$folder_id = null [protected]
$user [protected]
const ARTICLE = 1
const DOCUMENT = 3
const LOCATION = 4
const SEARCH = 2
const SHARED_ITEM = 5

The documentation for this class was generated from the following file: