CaMykS  1.0-20181201
 All Classes Files Functions Variables Pages
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
FileManager Class Reference
Inheritance diagram for FileManager:
Inheritance graph
[legend]
Collaboration diagram for FileManager:
Collaboration graph
[legend]

Public Member Functions

 __construct ($path_type)
 
 initialise ($params=array())
 
 execute_request ()
 
 set_objectName ($n)
 
 set_themeValues ($theme)
 
 set_folderValues ($path=null, $url=null, $title=null)
 
 set_engineValues ($mode=null, $url=null, $rights=null)
 
 set_browserValues ($size=null, $filter=null, $path=null)
 
 set_selectionValues ($function=null)
 
 get_runningValues ()
 
 check_allValues ()
 
 get_link ($page_value)
 
- Public Member Functions inherited from Input
 Input ($name, $path_type)
 
 initialise ($params=array())
 
 display ()
 
 get_translation ($value, $data=null)
 
 set_selectedLayout ($layout='')
 
- Public Member Functions inherited from Plugin
 __construct ($name, $plugin_type, $path_type)
 
 get_version ()
 
 load_library ($library='')
 
 load_file ($file='')
 
 load_varFile ($file='')
 
 load_engineFile ($file='')
 
 get_engineFileURL ($file='', $path=false)
 
 get_fileURL ($file='', $path=null, $default='')
 
 get_varFileURL ($file='', $path=false, $default='')
 
 get_filePath ($file='')
 
 get_varFilePath ($file='')
 
 add_JSFile ($file)
 
 add_JSEngineFile ($file)
 
 add_JSExternFile ($file)
 
 add_JSScript ($script, $unique=false)
 
 add_JSPreScript ($script, $unique=false)
 
 add_JSWindowEventScript ($event, $script, $unique=false)
 
 add_JSLoadScript ($script, $unique=false)
 
 add_JSUnloadScript ($script, $unique=false)
 
 add_styleFile ($file, $media='', $condition='')
 
 add_styleScript ($css)
 
 add_styleIncludedFile ($file)
 
 add_StyleExternFile ($file, $media='', $condition='')
 
 set_RSSFeed ($title, $url)
 
 add_headerExtra ($content='')
 
 install ()
 
 uninstall ()
 
 is_installed ()
 
 update ($version, $more='')
 
 add_translation ($more='', $lg=null)
 
 get_translation ($value, $data=null)
 
 get_languages ()
 
 execute_onCaMykSInitialise ()
 
 execute_onCaMykSPageLoad ()
 
 execute_onCaMykSBodyOpen ()
 
 execute_onCaMykSBodyClose ()
 
 execute_onCaMykSTerminate ()
 
 get_requestLink ($params=array())
 
 get_requestJSLink ($params=array())
 
 execute_request ()
 
 get_varFile ($file)
 

Public Attributes

 $winSize = '100%'
 Size of the manager view. More...
 
 $objname = 'fm'
 Manager object name. More...
 
 $theme
 Applied theme to the view. More...
 
 $folder_path
 Path to folder to manage. More...
 
 $folder_url
 URL to folder to manage. More...
 
 $folder_title
 Title of folder to manage. More...
 
 $engine_mode
 Selected mode for current view. More...
 
 $engine_url
 Url of current view. More...
 
 $engine_rights
 User rights for current view. More...
 
 $engine_action
 Action to execute in current view. More...
 
 $browser_maxfilesize
 Upload max file size. More...
 
 $browser_maxlevel
 Browser max level. More...
 
 $browser_view
 Browser current view. More...
 
 $browser_filter
 Browser current filter. More...
 
 $browser_path
 Browser current path. More...
 
 $browser_openpath
 Browser current open path. More...
 
 $browser_files
 Browser files. More...
 
 $selection_callback_function
 Callback function for selection mode. More...
 
- Public Attributes inherited from Input
 $title
 Input title. More...
 
 $params = array()
 Input parameters. More...
 
 $selected_layout = 'input.html.inc'
 Input layout to use. More...
 
- Public Attributes inherited from Plugin
 $name
 Plugin name. More...
 
 $version
 Plugin version. More...
 
 $active = false
 Plugin installation status. More...
 
 $plugin_package = ''
 Plugin package. More...
 
 $plugin_type
 Plugin type. More...
 
 $object_type
 Plugin type. More...
 
 $plugin_path
 Plugin path. More...
 
 $plugin_site_path
 Plugin site path (for element overwriting). More...
 
 $plugin_var_path
 Plugin var path. More...
 
 $plugin_url
 Plugin URL. More...
 
 $plugin_site_url
 Plugin site URL (for element overwriting). More...
 
 $plugin_var_url
 Plugin var URL. More...
 
 $path_type
 Plugin path type. More...
 
 $author_name
 Plugin author name. More...
 
 $author_mail
 Plugin author email. More...
 
 $author_group
 Plugin author group. More...
 
 $plugin_dependencies = array()
 Plugin dependencies. More...
 

Private Member Functions

 get_headerValues ()
 
 initialise_link_mode ()
 
 initialise_manage_mode ()
 
 initialise_selection_mode ()
 
 get_fileTree ()
 
 get_folderContent ($folder, $level)
 
 initialise_folder_execute ()
 
 initialise_file_execute ()
 
 initialise_trash_execute ()
 
 initialise_change_view_execute ()
 
 initialise_rename_execute ()
 
 initialise_download_execute ()
 
 initialise_columnsview ()
 
 build_columnsHTML (&$file, $level, $visible=false)
 
 build_columnsHTMLDescription (&$file, $level, $visible=false)
 
 initialise_listview ()
 
 build_listHTML (&$files, $level, $visible=false)
 

Private Attributes

 $modes = array('manage', 'selection', 'requestlink')
 Available mode list. More...
 
 $views = array('columns', )
 Available view list. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Plugin
 set_redirect ($time, $url= '')
 
 add_meta ($name, $content, $method='name')
 
 add_toHtaccess ($content='')
 
 add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
 
 set_dependencies ()
 
 register_asSharedObject ($name)
 
get_sharedObject ($name)
 
 register_asExtension ($plugin)
 
 get_registeredExtensions ()
 
 register_asCaMykSEventHandler ($event)
 

Detailed Description

FileManager Input class.

Constructor & Destructor Documentation

FileManager::__construct (   $path_type)

Class constructor.

Parameters
string$path_type
Returns
void

Member Function Documentation

FileManager::build_columnsHTML ( $file,
  $level,
  $visible = false 
)
private

Build html for columns view.

Parameters
array$file
int$level
boolean$visible
Returns
string
FileManager::build_columnsHTMLDescription ( $file,
  $level,
  $visible = false 
)
private

Build html for folder descriptions.

Parameters
array$file
int$level
boolean$visible
Returns
string
FileManager::build_listHTML ( $files,
  $level,
  $visible = false 
)
private

Build html for list view

Parameters
array$files
int$level
boolean$visible
Returns
string
FileManager::check_allValues ( )

Check all plugin values and complete them with default values

Returns
void
FileManager::execute_request ( )

Execute plugin engine as request

Returns
void
FileManager::get_fileTree ( )
private

Build file tree.

Returns
void
FileManager::get_folderContent (   $folder,
  $level 
)
private

Get folder content

Parameters
string$folder
integer$level
Returns
array
FileManager::get_headerValues ( )
private

Load all values from header

Returns
void
FileManager::get_link (   $page_value)

Request link mode link.

Parameters
mixed$page_value
Returns
string
FileManager::get_runningValues ( )

Get running values

Returns
void
FileManager::initialise (   $params = array())

Initialise input.

Returns
void
FileManager::initialise_change_view_execute ( )
private

Change file system view action.

Returns
void
FileManager::initialise_columnsview ( )
private

Specific initialization for columns view.

Returns
void
FileManager::initialise_download_execute ( )
private

Download a file action.

Returns
void
FileManager::initialise_file_execute ( )
private

Upload a file action.

Returns
void
FileManager::initialise_folder_execute ( )
private

Create a folder action.

Returns
void
FileManager::initialise_link_mode ( )
private

Plugin initialisation in link mode.

Returns
void
FileManager::initialise_listview ( )
private

Specific initialization for list view.

Returns
void
FileManager::initialise_manage_mode ( )
private

Plugin initialisation in view mode.

Returns
void
FileManager::initialise_rename_execute ( )
private

Rename a file or a folder action.

Returns
void
FileManager::initialise_selection_mode ( )
private

Initialise plugin in selection mode.

Returns
void
FileManager::initialise_trash_execute ( )
private

Trash a file action.

Returns
void
FileManager::set_browserValues (   $size = null,
  $filter = null,
  $path = null 
)

Define browser values.

Parameters
int$size
string$filter
string$path
Returns
void
FileManager::set_engineValues (   $mode = null,
  $url = null,
  $rights = null 
)

Define engine values

Parameters
string$mode
string$url
string$rights
Returns
void
FileManager::set_folderValues (   $path = null,
  $url = null,
  $title = null 
)

Define folder values.

Parameters
string$path
string$url
string$title
Returns
void
FileManager::set_objectName (   $n)

Update object name.

Parameters
string$n
Returns
void
FileManager::set_selectionValues (   $function = null)

Define specific to selection mode values.

Parameters
string$function
Returns
void
FileManager::set_themeValues (   $theme)

Define theme.

Parameters
Object$theme
Returns
void

Member Data Documentation

FileManager::$browser_files

Browser files.

var array $browser_files

FileManager::$browser_filter

Browser current filter.

var string $browser_filter

FileManager::$browser_maxfilesize

Upload max file size.

var string $browser_maxfilesize

FileManager::$browser_maxlevel

Browser max level.

var string $browser_maxlevel

FileManager::$browser_openpath

Browser current open path.

var string $browser_openpath

FileManager::$browser_path

Browser current path.

var string $browser_path

FileManager::$browser_view

Browser current view.

var string $browser_view

FileManager::$engine_action

Action to execute in current view.

var string $engine_action

FileManager::$engine_mode

Selected mode for current view.

var string $engine_mode

FileManager::$engine_rights

User rights for current view.

var string $engine_rights

FileManager::$engine_url

Url of current view.

var string $engine_url

FileManager::$folder_path

Path to folder to manage.

var string $folder_path

FileManager::$folder_title

Title of folder to manage.

var string $folder_title

FileManager::$folder_url

URL to folder to manage.

var string $folder_url

FileManager::$modes = array('manage', 'selection', 'requestlink')
private

Available mode list.

var array $modes

FileManager::$objname = 'fm'

Manager object name.

var string $objname

FileManager::$selection_callback_function

Callback function for selection mode.

var string $selection_callback_function

FileManager::$theme

Applied theme to the view.

var array $views

FileManager::$views = array('columns', )
private

Available view list.

var array $views

FileManager::$winSize = '100%'

Size of the manager view.

var string $winSize


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