PHP Класс Contao\DC_Folder

Наследование: extends DataContainer, implements listable, implements editable
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$arrCounts array Counts
$arrFilemounts array Current filemounts
$arrMessages array Messages
$arrValidFileTypes array Valid file types
$blnCreateNewVersion boolean True if a new version has to be created
$blnIsDbAssisted boolean Database assisted
$strExtension string Current file extension
$strPath string Current path

Открытые методы

Метод Описание
__construct ( string $strTable ) Initialize the object
__get ( string $strKey ) : mixed Return an object property
__set ( string $strKey, mixed $varValue ) Set an object property
ajaxTreeView ( string $strFolder, integer $level ) : string Generate a particular subpart of the tree and return it as HTML string
copy ( string $source = null, string $destination = null ) Recursively duplicate files and folders
copyAll ( ) Move all selected files and folders
create ( ) Create a new folder
cut ( string $source = null ) Move an existing file or folder
cutAll ( ) Move all selected files and folders
delete ( string $source = null ) Recursively delete files and folders
deleteAll ( ) Delete all files and folders that are currently shown
edit ( ) : string Auto-generate a form to rename a file or folder
editAll ( ) : string Auto-generate a form to edit all records that are currently shown
getPalette ( ) : string Return the name of the current palette
move ( boolean $blnIsAjax = false ) : string Move one or more local files to the server
protect ( ) Protect a folder
show ( ) : string Automatically switch to showAll
showAll ( ) : string List all files and folders of the file system
source ( ) : string Load the source editor
sync ( ) : string Synchronize the file system with the database
undo ( ) : string Automatically switch to showAll

Защищенные методы

Метод Описание
generateTree ( string $path, integer $intMargin, boolean $mount = false, boolean $blnProtected = true, array $arrClipboard = null, array $arrFound = [] ) : string Render the file tree and return it as HTML string
getMD5Folders ( string $strPath ) : array Return an array of encrypted folder names
isMounted ( string $strFolder ) : boolean Return true if the current folder is mounted
isProtectedPath ( string $path ) : boolean Check if a path is protected (see #287)
isValid ( string $strFile ) : boolean Check a file operation
panel ( ) : string Build the sort panel and return it as string
save ( mixed $varValue ) Save the current value
searchMenu ( ) : string Return a search form that allows to search results using regular expressions

Описание методов

__construct() публичный Метод

Initialize the object
public __construct ( string $strTable )
$strTable string

__get() публичный Метод

Return an object property
public __get ( string $strKey ) : mixed
$strKey string
Результат mixed

__set() публичный Метод

Set an object property
public __set ( string $strKey, mixed $varValue )
$strKey string
$varValue mixed

ajaxTreeView() публичный Метод

Generate a particular subpart of the tree and return it as HTML string
public ajaxTreeView ( string $strFolder, integer $level ) : string
$strFolder string
$level integer
Результат string

copy() публичный Метод

Recursively duplicate files and folders
public copy ( string $source = null, string $destination = null )
$source string
$destination string

copyAll() публичный Метод

Move all selected files and folders
public copyAll ( )

create() публичный Метод

Create a new folder
public create ( )

cut() публичный Метод

Move an existing file or folder
public cut ( string $source = null )
$source string

cutAll() публичный Метод

Move all selected files and folders
public cutAll ( )

delete() публичный Метод

Recursively delete files and folders
public delete ( string $source = null )
$source string

deleteAll() публичный Метод

Delete all files and folders that are currently shown
public deleteAll ( )

edit() публичный Метод

Auto-generate a form to rename a file or folder
public edit ( ) : string
Результат string

editAll() публичный Метод

Auto-generate a form to edit all records that are currently shown
public editAll ( ) : string
Результат string

generateTree() защищенный Метод

Render the file tree and return it as HTML string
protected generateTree ( string $path, integer $intMargin, boolean $mount = false, boolean $blnProtected = true, array $arrClipboard = null, array $arrFound = [] ) : string
$path string
$intMargin integer
$mount boolean
$blnProtected boolean
$arrClipboard array
$arrFound array
Результат string

getMD5Folders() защищенный Метод

Return an array of encrypted folder names
protected getMD5Folders ( string $strPath ) : array
$strPath string
Результат array

getPalette() публичный Метод

Return the name of the current palette
public getPalette ( ) : string
Результат string

isMounted() защищенный Метод

Return true if the current folder is mounted
protected isMounted ( string $strFolder ) : boolean
$strFolder string
Результат boolean

isProtectedPath() защищенный Метод

Check if a path is protected (see #287)
protected isProtectedPath ( string $path ) : boolean
$path string
Результат boolean

isValid() защищенный Метод

Check a file operation
protected isValid ( string $strFile ) : boolean
$strFile string
Результат boolean

move() публичный Метод

Move one or more local files to the server
public move ( boolean $blnIsAjax = false ) : string
$blnIsAjax boolean
Результат string

panel() защищенный Метод

Build the sort panel and return it as string
protected panel ( ) : string
Результат string

protect() публичный Метод

Protect a folder
public protect ( )

save() защищенный Метод

Save the current value
protected save ( mixed $varValue )
$varValue mixed

searchMenu() защищенный Метод

Return a search form that allows to search results using regular expressions
protected searchMenu ( ) : string
Результат string

show() публичный Метод

Automatically switch to showAll
public show ( ) : string
Результат string

showAll() публичный Метод

List all files and folders of the file system
public showAll ( ) : string
Результат string

source() публичный Метод

Load the source editor
public source ( ) : string
Результат string

sync() публичный Метод

Synchronize the file system with the database
public sync ( ) : string
Результат string

undo() публичный Метод

Automatically switch to showAll
public undo ( ) : string
Результат string

Описание свойств

$arrCounts защищенное свойство

Counts
protected array $arrCounts
Результат array

$arrFilemounts защищенное свойство

Current filemounts
protected array $arrFilemounts
Результат array

$arrMessages защищенное свойство

Messages
protected array $arrMessages
Результат array

$arrValidFileTypes защищенное свойство

Valid file types
protected array $arrValidFileTypes
Результат array

$blnCreateNewVersion защищенное свойство

True if a new version has to be created
protected bool $blnCreateNewVersion
Результат boolean

$blnIsDbAssisted защищенное свойство

Database assisted
protected bool $blnIsDbAssisted
Результат boolean

$strExtension защищенное свойство

Current file extension
protected string $strExtension
Результат string

$strPath защищенное свойство

Current path
protected string $strPath
Результат string