Public Member Functions |
| __construct ($config, $parentBase, $section_id, $translationTable, $page, $tree_id, $root_folder= '', $title=null) |
| getPageContent () |
Static Public Member Functions |
static | canUpload ($user, $folder, $config) |
static | getFolder ($page, $root_folder= '') |
static | m_rename ($source, $destination) |
static | m_unlink ($path) |
static | removeItem ($user, $page, $root_folder, $item_path, $translationTable, $config) |
static | createFolder ($user, $page, $root_folder, $name, $translationTable, $config) |
static | moveItem ($user, $page, $root_folder, $type, $source, $destination, $translationTable, $config) |
Data Fields |
const | THEME_PAGE = 'theme' |
Protected Attributes |
| $tree_id = null |
Constructor & Destructor Documentation
__construct |
( |
$ |
config, |
|
|
$ |
parentBase, |
|
|
$ |
section_id, |
|
|
$ |
translationTable, |
|
|
$ |
page, |
|
|
$ |
tree_id, |
|
|
$ |
root_folder = '' , |
|
|
$ |
title = null |
|
) |
| |
Constructs the object
- Parameters:
-
array | $config | The configuration array |
string | $parentBase | base_folder of the container class |
string | $section_id | The section identifier |
array | $translationTable | The translation table |
string | $page | The page in which the control will be displayed |
string | $tree_id | The tree HTML identifier |
string | $root_folder | The root folder of the uploads [OPTIONAL] |
string | $title | The title of the document repository public |
- Returns:
- void
Member Function Documentation
static canUpload |
( |
$ |
user, |
|
|
$ |
folder, |
|
|
$ |
config |
|
) |
| [static] |
If true, then the user can modify the current folder
- Parameters:
-
tariqaUser | $user | The current user |
string | $folder | The folder |
string | $config | The application configuration array public |
- Returns:
- boolean
static createFolder |
( |
$ |
user, |
|
|
$ |
page, |
|
|
$ |
root_folder, |
|
|
$ |
name, |
|
|
$ |
translationTable, |
|
|
$ |
config |
|
) |
| [static] |
Creates a new folder
- Parameters:
-
tariqaUser | $user | The user which is trying to create a new folder |
string | $page | The current page in which the upload control is displayed |
string | $root_folder | The root folder (for example the theme id or the country id) |
string | $name | The name of the new folder |
array | $translationTable | The translation table |
string | $config | The application configuration array public |
- Returns:
- string
static getFolder |
( |
$ |
page, |
|
|
$ |
root_folder = '' |
|
) |
| [static] |
Retrieves the folder in which the upload will take place
- Parameters:
-
string | $page | The page in which the control is displayed |
string | $root_folder | The root folder of the upload [OPTIONAL] public |
- Returns:
- string
Render the module
- Returns:
- string
Reimplemented from tariqa3Module.
static m_rename |
( |
$ |
source, |
|
|
$ |
destination |
|
) |
| [static] |
Moves a folder from source to destination
- Parameters:
-
string | $source | The source path |
string | $destination | The destination path public |
- Returns:
- void
Removes a file or a folder
- Parameters:
-
string | $path | The path to the item public |
- Returns:
- int
static moveItem |
( |
$ |
user, |
|
|
$ |
page, |
|
|
$ |
root_folder, |
|
|
$ |
type, |
|
|
$ |
source, |
|
|
$ |
destination, |
|
|
$ |
translationTable, |
|
|
$ |
config |
|
) |
| [static] |
Moves an item
- Parameters:
-
tariqaUser | $user | The current user |
string | $page | The current page in which the upload control is displayed |
string | $root_folder | The root folder (for example the theme id or the country id) |
string | $type | The type of the source (file or folder) |
string | $source | The source |
string | $destination | The destination |
array | $translationTable | The translation table |
string | $config | The application configuration array public |
- Returns:
- string
static removeItem |
( |
$ |
user, |
|
|
$ |
page, |
|
|
$ |
root_folder, |
|
|
$ |
item_path, |
|
|
$ |
translationTable, |
|
|
$ |
config |
|
) |
| [static] |
Removes a file or a folder
- Parameters:
-
tariqaUser | $user | The user trying to perform the removal |
string | $page | The page in which the controller is being displayed |
string | $root_folder | The root folder |
string | $item_path | The path to the item to be deleted |
array | $translationTable | The translation table |
array | $config | The application configuration array public |
- Returns:
- string
Field Documentation
$tree_id = null [protected] |
The documentation for this class was generated from the following file: