[ class tree: core ] [ index: core ] [ all elements ]

Class: elFinderVolumeLocalFileSystem

Source Location: /zp-extensions/elFinder/php/elFinderVolumeLocalFileSystem.class.php

Class elFinderVolumeLocalFileSystem

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From elFinderVolumeDriver

elFinderVolumeDriver::$access
elFinderVolumeDriver::$archivers
elFinderVolumeDriver::$attributes
elFinderVolumeDriver::$cache
elFinderVolumeDriver::$cryptLib
elFinderVolumeDriver::$defaults
elFinderVolumeDriver::$diabled
elFinderVolumeDriver::$dirsCache
elFinderVolumeDriver::$error
elFinderVolumeDriver::$finfo
elFinderVolumeDriver::$id
elFinderVolumeDriver::$imgLib
elFinderVolumeDriver::$mimeDetect
elFinderVolumeDriver::$mimetypes
elFinderVolumeDriver::$mounted
elFinderVolumeDriver::$onlyMimes
elFinderVolumeDriver::$options
elFinderVolumeDriver::$removed
elFinderVolumeDriver::$root
elFinderVolumeDriver::$rootName
elFinderVolumeDriver::$separator
elFinderVolumeDriver::$startPath
elFinderVolumeDriver::$tmbPath
elFinderVolumeDriver::$tmbPathWritable
elFinderVolumeDriver::$tmbSize
elFinderVolumeDriver::$tmbURL
elFinderVolumeDriver::$today
elFinderVolumeDriver::$treeDeep
elFinderVolumeDriver::$uploadAllow
elFinderVolumeDriver::$uploadDeny
elFinderVolumeDriver::$uploadMaxSize
elFinderVolumeDriver::$uploadOrder
elFinderVolumeDriver::$URL
elFinderVolumeDriver::$yesterday

Inherited From elFinderVolumeDriver

elFinderVolumeDriver::allowCreate()
Return true if file with given name can be created in given folder.
elFinderVolumeDriver::archive()
Add files to archive
elFinderVolumeDriver::attr()
Check file attribute
elFinderVolumeDriver::cacheDir()
Get stat for folder content and put in cache
elFinderVolumeDriver::canCreateTmb()
Return true if thumnbnail for required file can be created
elFinderVolumeDriver::canResize()
Return true if required file can be resized.
elFinderVolumeDriver::childsByAttr()
Return first found children with required attr == $val
elFinderVolumeDriver::clearcache()
Clean cache
elFinderVolumeDriver::close()
Close file pointer
elFinderVolumeDriver::closest()
Return file/dir hash or first founded child hash with required attr == $val
elFinderVolumeDriver::closestByAttr()
If file has required attr == $val - return file path, If dir has child with has required attr == $val - return child path
elFinderVolumeDriver::commandDisabled()
Return true if command disabled in options
elFinderVolumeDriver::configure()
Configure after successfull mount.
elFinderVolumeDriver::copy()
Copy file/recursive copy dir only in current volume.
elFinderVolumeDriver::copyFrom()
Copy file from another volume.
elFinderVolumeDriver::copyFromAllowed()
Return true if copy from this volume allowed
elFinderVolumeDriver::countSize()
Return file/total directory size
elFinderVolumeDriver::createTmb()
Create thumnbnail and return it's URL on success
elFinderVolumeDriver::crypt()
Return crypted path Not implemented
elFinderVolumeDriver::debug()
Return debug info for client
elFinderVolumeDriver::decode()
Decode path from hash
elFinderVolumeDriver::defaultPath()
Return root or startPath hash
elFinderVolumeDriver::dimensions()
Return image dimensions
elFinderVolumeDriver::dir()
Return folder info
elFinderVolumeDriver::doSearch()
Recursive files search
elFinderVolumeDriver::driverId()
Return driver id. Used as a part of volume id.
elFinderVolumeDriver::duplicate()
Create file copy with suffix "copy number" and return its info
elFinderVolumeDriver::encode()
Encode path into hash
elFinderVolumeDriver::error()
Return error message from last failed action
elFinderVolumeDriver::extract()
Extract files from archive
elFinderVolumeDriver::file()
Return file info or false on error
elFinderVolumeDriver::gdImage()
Output gd image to file
elFinderVolumeDriver::gdImageBackground()
Assign the proper background to a gd image
elFinderVolumeDriver::gdImageCreate()
Create an gd image according to the specified mime type
elFinderVolumeDriver::getContents()
Return file contents
elFinderVolumeDriver::getContentUrl()
Return content URL (for netmout volume driver) If file.url == 1 requests from JavaScript client with XHR
elFinderVolumeDriver::getScandir()
Return required dir's files info.
elFinderVolumeDriver::getTempPath()
Return temp path
elFinderVolumeDriver::gettmb()
Return thumnbnail name if exists
elFinderVolumeDriver::gettree()
Return subdirs tree
elFinderVolumeDriver::id()
Return volume id
elFinderVolumeDriver::imgCrop()
Crop image
elFinderVolumeDriver::imgResize()
Resize image
elFinderVolumeDriver::imgRotate()
Rotate image
elFinderVolumeDriver::imgSquareFit()
Put image to square
elFinderVolumeDriver::init()
Prepare driver before mount volume.
elFinderVolumeDriver::isReadable()
Return true if voume is readable.
elFinderVolumeDriver::isSameType()
Return true if all mimes is directory or files
elFinderVolumeDriver::ls()
Return dir files names list
elFinderVolumeDriver::mimeAccepted()
Return true if mime is required mimes list
elFinderVolumeDriver::mimetype()
Return file mimetype
elFinderVolumeDriver::mimetypeInternalDetect()
Detect file mimetype using "internal" method
elFinderVolumeDriver::mkdir()
Create directory and return dir info
elFinderVolumeDriver::mkfile()
Create empty file and return its info
elFinderVolumeDriver::mount()
"Mount" volume.
elFinderVolumeDriver::move()
Move file Return new file path or false.
elFinderVolumeDriver::nameAccepted()
Validate file name based on $this->options['acceptedName'] regexp
elFinderVolumeDriver::open()
Open file for reading and return file pointer
elFinderVolumeDriver::options()
Return volume options required by client:
elFinderVolumeDriver::parents()
Return part of dirs tree from required dir up to root dir
elFinderVolumeDriver::paste()
Paste files
elFinderVolumeDriver::path()
Return file path related to root
elFinderVolumeDriver::procExec()
Execute shell command
elFinderVolumeDriver::putContents()
Put content in text file and return file info.
elFinderVolumeDriver::realpath()
Return file real path if file exists
elFinderVolumeDriver::remove()
Remove file/ recursive remove dir
elFinderVolumeDriver::removed()
Return list of moved/overwrited files
elFinderVolumeDriver::rename()
Rename file and return file info
elFinderVolumeDriver::resetRemoved()
Clean removed files list
elFinderVolumeDriver::resize()
Resize image
elFinderVolumeDriver::rm()
Remove file/dir
elFinderVolumeDriver::rmTmb()
Remove thumbnail, also remove recursively if stat is directory
elFinderVolumeDriver::root()
Return root folder hash
elFinderVolumeDriver::scandir()
Return directory content or false on error
elFinderVolumeDriver::search()
Search files
elFinderVolumeDriver::setError()
Save error message
elFinderVolumeDriver::setMimesFilter()
Set mimetypes allowed to display to client
elFinderVolumeDriver::size()
Return file size / total directory size
elFinderVolumeDriver::stat()
Return fileinfo
elFinderVolumeDriver::stripos()
Find position of first occurrence of string in a string with multibyte support
elFinderVolumeDriver::tmb()
Create thumbnail for required file and return its name of false on failed
elFinderVolumeDriver::tmbname()
Return thumbnail file name for required file
elFinderVolumeDriver::tree()
Return subfolders for required folder or false on error
elFinderVolumeDriver::umount()
Some "unmount" stuffs - may be required by virtual fs
elFinderVolumeDriver::uncrypt()
Return uncrypted path Not implemented
elFinderVolumeDriver::uniqueName()
Return new unique name based on file name and suffix
elFinderVolumeDriver::updateCache()
Put file stat in cache and return it
elFinderVolumeDriver::upload()
Save uploaded file.
elFinderVolumeDriver::_abspath()
Convert path related to root dir into real path
elFinderVolumeDriver::_archive()
Create archive and return its path
elFinderVolumeDriver::_basename()
Return file name
elFinderVolumeDriver::_checkArchivers()
Detect available archivers
elFinderVolumeDriver::_copy()
Copy file into another file (only inside one volume)
elFinderVolumeDriver::_dimensions()
Return object width and height Ususaly used for images, but can be realize for video etc...
elFinderVolumeDriver::_dirname()
Return parent directory path
elFinderVolumeDriver::_extract()
Extract files from archive
elFinderVolumeDriver::_fclose()
Close opened file
elFinderVolumeDriver::_filePutContents()
Write a string to a file
elFinderVolumeDriver::_fopen()
Open file and return file pointer
elFinderVolumeDriver::_getContents()
Get file contents
elFinderVolumeDriver::_inpath()
Return true if $path is children of $parent
elFinderVolumeDriver::_joinPath()
Join dir name and file name and return full path.
elFinderVolumeDriver::_mkdir()
Create dir and return created dir path or false on failed
elFinderVolumeDriver::_mkfile()
Create file and return it's path or false on failed
elFinderVolumeDriver::_move()
Move file into another parent dir.
elFinderVolumeDriver::_normpath()
Return normalized path
elFinderVolumeDriver::_path()
Return fake path started from root dir.
elFinderVolumeDriver::_relpath()
Return file path related to root dir
elFinderVolumeDriver::_rmdir()
Remove dir
elFinderVolumeDriver::_save()
Create new file and write into it from file pointer.
elFinderVolumeDriver::_scandir()
Return files list in directory
elFinderVolumeDriver::_stat()
Return stat for given path.
elFinderVolumeDriver::_subdirs()
Return true if path is dir and has at least one childs directory
elFinderVolumeDriver::_symlink()
Create symlink
elFinderVolumeDriver::_unlink()
Remove file

[ Top ]
Property Summary
int   $archiveSize   Required to count total archive files size
string   $driverId   Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id

[ Top ]
Method Summary
void   __construct()   Constructor Extend options with required fields
void   configure()   Configure after successfull mount.
string   readlink()   Return symlink target file
string   _abspath()   Convert path related to root dir into real path
string|bool   _archive()   Create archive and return its path
string   _basename()   Return file name
void   _checkArchivers()   Detect available archivers
bool   _copy()   Copy file into another file
string   _dimensions()   Return object width and height Usualy used for images, but can be realize for video etc...
string   _dirname()   Return parent directory path
true   _extract()   Extract files from archive
bool   _fclose()   Close opened file
bool   _filePutContents()   Write a string to a file
bool   _findSymlinks()   Recursive symlinks search
resource|false   _fopen()   Open file and return file pointer
string|false   _getContents()   Get file contents
bool   _inpath()   Return true if $path is children of $parent
string   _joinPath()   Join dir name and file name and retur full path
string|bool   _mkdir()   Create dir and return created dir path or false on failed
string|bool   _mkfile()   Create file and return it's path or false on failed
string|bool   _move()   Move file into another parent dir.
string   _normpath()   Return normalized path, this works the same as os.path.normpath() in Python
string   _path()   Return fake path started from root dir
string   _relpath()   Return file path related to root dir
bool   _rmdir()   Remove dir
bool|string   _save()   Create new file and write into it from file pointer.
array   _scandir()   Return files list in directory.
array|false   _stat()   Return stat for given path.
bool   _subdirs()   Return true if path is dir and has at least one childs directory
bool   _symlink()   Create symlink
bool   _unlink()   Remove file
void   _unpack()   Unpack archive

[ Top ]
Properties
int   $archiveSize = 0 [line 25]

Required to count total archive files size

API Tags:
Access:  protected


[ Top ]
string   $driverId = 'l' [line 18]

Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id

API Tags:
Access:  protected


Redefinition of:
elFinderVolumeDriver::$driverId
Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id

[ Top ]
Methods
Constructor __construct  [line 34]

  void __construct( )

Constructor Extend options with required fields


API Tags:
Access:  public

Information Tags:
Author:  Dmitry (dio) Levashov

[ Top ]
configure  [line 52]

  void configure( )

Configure after successfull mount.


API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::configure()
Configure after successfull mount.

[ Top ]
readlink  [line 345]

  string readlink( string $path  )

Return symlink target file

Parameters:
string   $path:  link path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

[ Top ]
_abspath  [line 209]

  string _abspath( string $path  )

Convert path related to root dir into real path

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_abspath()
Convert path related to root dir into real path

[ Top ]
_archive  [line 823]

  string|bool _archive( string $dir, array $files, string $name, array $arc  )

Create archive and return its path

Parameters:
string   $dir:  target dir
array   $files:  files names list
string   $name:  archive name
array   $arc:  archiver options

API Tags:
Access:  protected

Information Tags:
Author:  Alexey Sukhotin
Author:  Dmitry (dio) Levashov,

Redefinition of:
elFinderVolumeDriver::_archive()
Create archive and return its path

[ Top ]
_basename  [line 125]

  string _basename( string $path  )

Return file name

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_basename()
Return file name

[ Top ]
_checkArchivers  [line 573]

  void _checkArchivers( )

Detect available archivers


API Tags:
Access:  protected


Redefinition of:
elFinderVolumeDriver::_checkArchivers()
Detect available archivers

[ Top ]
_copy  [line 473]

  bool _copy( string $source, string $targetDir, string $name  )

Copy file into another file

Parameters:
string   $source:  source file path
string   $targetDir:  target directory path
string   $name:  new file name

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_copy()
Copy file into another file (only inside one volume)

[ Top ]
_dimensions  [line 330]

  string _dimensions( string $path, string $mime  )

Return object width and height Usualy used for images, but can be realize for video etc...

Parameters:
string   $path:  file path
string   $mime:  file mime type

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_dimensions()
Return object width and height Ususaly used for images, but can be realize for video etc...

[ Top ]
_dirname  [line 114]

  string _dirname( string $path  )

Return parent directory path

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_dirname()
Return parent directory path

[ Top ]
_extract  [line 727]

  true _extract( string $path, array $arc  )

Extract files from archive

Parameters:
string   $path:  archive path
array   $arc:  archiver command and arguments (same as in $this->archivers)

API Tags:
Access:  protected

Information Tags:
Author:  Alexey Sukhotin
Author:  Dmitry (dio) Levashov,

Redefinition of:
elFinderVolumeDriver::_extract()
Extract files from archive

[ Top ]
_fclose  [line 407]

  bool _fclose( resource $fp, [ $path = '']  )

Close opened file

Parameters:
resource   $fp:  file pointer
   $path: 

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_fclose()
Close opened file

[ Top ]
_filePutContents  [line 560]

  bool _filePutContents( string $path, string $content  )

Write a string to a file

Parameters:
string   $path:  file path
string   $content:  new file content

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_filePutContents()
Write a string to a file

[ Top ]
_findSymlinks  [line 691]

  bool _findSymlinks( string $path  )

Recursive symlinks search

Parameters:
string   $path:  file/dir path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

[ Top ]
_fopen  [line 396]

  resource|false _fopen( string $path, [ $mode = 'rb'], bool $write  )

Open file and return file pointer

Parameters:
string   $path:  file path
bool   $write:  open file for writing
   $mode: 

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_fopen()
Open file and return file pointer

[ Top ]
_getContents  [line 548]

  string|false _getContents( string $path  )

Get file contents

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_getContents()
Get file contents

[ Top ]
_inpath  [line 232]

  bool _inpath( string $path, string $parent  )

Return true if $path is children of $parent

Parameters:
string   $path:  path to check
string   $parent:  parent path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_inpath()
Return true if $path is children of $parent

[ Top ]
_joinPath  [line 137]

  string _joinPath( string $dir, string $name  )

Join dir name and file name and retur full path

Parameters:
string   $dir: 
string   $name: 

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_joinPath()
Join dir name and file name and return full path.

[ Top ]
_mkdir  [line 421]

  string|bool _mkdir( string $path, string $name  )

Create dir and return created dir path or false on failed

Parameters:
string   $path:  parent dir path
string   $name:  new directory name

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_mkdir()
Create dir and return created dir path or false on failed

[ Top ]
_mkfile  [line 440]

  string|bool _mkfile( string $path, string $name  )

Create file and return it's path or false on failed

Parameters:
string   $path:  parent dir path
string   $name:  new file name

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_mkfile()
Create file and return it's path or false on failed

[ Top ]
_move  [line 487]

  string|bool _move( string $source, $targetDir, string $name, string $target  )

Move file into another parent dir.

Return new file path or false.

Parameters:
string   $source:  source file path
string   $target:  target dir path
string   $name:  file name
   $targetDir: 

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_move()
Move file into another parent dir.

[ Top ]
_normpath  [line 148]

  string _normpath( string $path  )

Return normalized path, this works the same as os.path.normpath() in Python

Parameters:
string   $path:  path

API Tags:
Access:  protected

Information Tags:
Author:  Troex Nevelin

Redefinition of:
elFinderVolumeDriver::_normpath()
Return normalized path

[ Top ]
_path  [line 220]

  string _path( string $path  )

Return fake path started from root dir

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_path()
Return fake path started from root dir.

[ Top ]
_relpath  [line 198]

  string _relpath( string $path  )

Return file path related to root dir

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_relpath()
Return file path related to root dir

[ Top ]
_rmdir  [line 510]

  bool _rmdir( string $path  )

Remove dir

Parameters:
string   $path:  dir path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_rmdir()
Remove dir

[ Top ]
_save  [line 525]

  bool|string _save( resource $fp, string $dir, string $name, array $stat  )

Create new file and write into it from file pointer.

Return new file path or false on error.

Parameters:
resource   $fp:  file pointer
string   $dir:  target dir path
string   $name:  file name
array   $stat:  file stat (required by some virtual fs)

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_save()
Create new file and write into it from file pointer.

[ Top ]
_scandir  [line 377]

  array _scandir( string $path  )

Return files list in directory.

Parameters:
string   $path:  dir path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_scandir()
Return files list in directory

[ Top ]
_stat  [line 259]

  array|false _stat( string $path  )

Return stat for given path.

Stat contains following fields:

  • (int) size file size in b. required
  • (int) ts file modification time in unix time. required
  • (string) mime mimetype. required for folders, others - optionally
  • (bool) read read permissions. required
  • (bool) write write permissions. required
  • (bool) locked is object locked. optionally
  • (bool) hidden is object hidden. optionally
  • (string) alias for symlinks - link target path relative to root path. optionally
  • (string) target for symlinks - link target path. optionally
If file does not exists - returns empty array or false.

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_stat()
Return stat for given path.

[ Top ]
_subdirs  [line 305]

  bool _subdirs( string $path  )

Return true if path is dir and has at least one childs directory

Parameters:
string   $path:  dir path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_subdirs()
Return true if path is dir and has at least one childs directory

[ Top ]
_symlink  [line 460]

  bool _symlink( string $source, string $targetDir, string $name  )

Create symlink

Parameters:
string   $source:  file to link to
string   $targetDir:  folder to create link in
string   $name:  symlink name

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_symlink()
Create symlink

[ Top ]
_unlink  [line 499]

  bool _unlink( string $path  )

Remove file

Parameters:
string   $path:  file path

API Tags:
Access:  protected

Information Tags:
Author:  Dmitry (dio) Levashov

Redefinition of:
elFinderVolumeDriver::_unlink()
Remove file

[ Top ]
_unpack  [line 675]

  void _unpack( string $path, array $arc  )

Unpack archive

Parameters:
string   $path:  archive path
array   $arc:  archiver command and arguments (same as in $this->archivers)

API Tags:
Access:  protected

Information Tags:
Author:  Alexey Sukhotin
Author:  Dmitry (dio) Levashov

[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:27 +0200 by phpDocumentor 1.4.3