Class elFinderVolumeBox

Simple elFinder driver for BoxDrive Box.com API v2.0.

elFinderVolumeBox

Author: Dmitry (dio) Levashov
Author: Cem (discofever)
Located at zp-extensions/elFinder/php/elFinderVolumeBox.class.php

Methods summary
`public`	# `__construct( )` Constructor Extend options with required fields. Constructor Extend options with required fields. Author Dmitry (dio) Levashov Cem (DiscoFever)
`protected array`	# `_bd_splitPath( string $path )` Get Parent ID, Item ID, Parent Path as an array from path. Get Parent ID, Item ID, Parent Path as an array from path. Parameters `$path` Returns array
`protected boolean\|object`	# `_bd_obtainAccessToken( string $client_id, string $client_secret, string $code )` Obtains a new access token from OAuth. This token is valid for one hour. Obtains a new access token from OAuth. This token is valid for one hour. Parameters `$client_id` $clientSecret The Box client secret `$client_secret` $code The code returned by Box after successful log in `$code` $redirectUri Must be the same as the redirect URI passed to LoginUrl Returns boolean\|object Throws Exception Thrown if this Client instance's clientId is not set Exception Thrown if the redirect URI of this Client instance's state is not set
`protected true\|string`	# `_bd_refreshToken( )` Get token and auto refresh. Get token and auto refresh. Returns true\|string error message Throws Exception
`protected resource`	# `_bd_prepareCurl( array $options = array() )` Creates a base cURL object which is compatible with the Box.com API. Creates a base cURL object which is compatible with the Box.com API. Parameters `$options` cURL options Returns resource A compatible cURL object
`protected boolean\|array`	# `_bd_fetch( $url, boolean $contents = false )` Creates a base cURL object which is compatible with the Box.com API. Creates a base cURL object which is compatible with the Box.com API. Parameters `$url` `$contents` Returns boolean\|array Throws Exception
`protected mixed`	# `_bd_curlExec( resource $curl, boolean\|string $decodeOrParent = true, array $headers = array(), $postData = array() )` Call curl_exec(). Call curl_exec(). Parameters `$curl` `$decodeOrParent` `$headers` `$postData` Returns mixed Throws Exception
`protected boolean\|object`	# `_bd_query( $itemId, boolean $fetch_self = false, boolean $recursive = false )` Drive query and fetchAll. Drive query and fetchAll. Parameters `$itemId` `$fetch_self` `$recursive` Returns boolean\|object Throws Exception
`protected object`	# `_bd_getRawItem( string $path )` Get dat(box metadata) from Box.com. Get dat(box metadata) from Box.com. Parameters `$path` Returns object box metadata Throws Exception
`protected array`	# `_bd_parseRaw( object $raw )` Parse line from box metadata output and return file stat (array). Parse line from box metadata output and return file stat (array). Parameters `$raw` line from ftp_rawlist() output Returns array Author Dmitry Levashov
`protected string`	# `_bd_getThumbnail( string $path, string $size,… )` Get thumbnail from Box.com. Get thumbnail from Box.com. Parameters `$path` `$size`,… Returns string \| boolean
`protected boolean`	# `_bd_unlink( string $path, $type = null )` Remove item. Remove item. Parameters `$path` file path `$type` Returns boolean
`protected string`	# `_bd_getATokenFile( )` Get AccessToken file path Get AccessToken file path Returns string ( description_of_the_return_value )
`protected string`	# `_bd_getInitialToken( )` Get Initial Token (MD5 hash) Get Initial Token (MD5 hash) Returns string
`public array`	# `netmountPrepare( $options )` Prepare Call from elFinder::netmout() before volume->mount(). Prepare Call from elFinder::netmout() before volume->mount(). Returns array Author Naoki Sawada Raja Sharma updating for Box
`public boolean`	# `netunmount( $netVolumes, $key )` process of on netunmount Drop `box` & rm thumbs. process of on netunmount Drop `box` & rm thumbs. Parameters `$netVolumes` `$key` Returns boolean
`public array`	# `debug( )` Return debug info for client. Return debug info for client. Returns array Overrides `elFinderVolumeDriver::debug()`
`protected boolean`	# `init( )` Prepare FTP connection Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn. Prepare FTP connection Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn. Returns boolean Throws Exception Author Dmitry (dio) Levashov Cem (DiscoFever) Overrides `elFinderVolumeDriver::init()`
`protected`	# `configure( )` Configure after successfull mount. Configure after successfull mount. Throws `elFinderAbortException` Author Dmitry (dio) Levashov Overrides `elFinderVolumeDriver::configure()`
`public`	# `umount( )` Close opened connection. Close opened connection. Author Dmitry (dio) Levashov Overrides `elFinderVolumeDriver::umount()`
`protected array\|boolean`	# `isNameExists( string $path )` Return fileinfo based on filename For item ID based path file system Please override if needed on each drivers. Return fileinfo based on filename For item ID based path file system Please override if needed on each drivers. Parameters `$path` file cache Returns array\|boolean Throws `elFinderAbortException` Overrides `elFinderVolumeDriver::isNameExists()`
`protected`	# `cacheDir( string $path )` Cache dir contents. Cache dir contents. Parameters `$path` dir path Returns Throws Exception Author Dmitry Levashov Overrides `elFinderVolumeDriver::cacheDir()`
`protected string\|false`	# `copy( string $src, string $dst, string $name )` Copy file/recursive copy dir only in current volume. Return new file path or false. Copy file/recursive copy dir only in current volume. Return new file path or false. Parameters `$src` source path `$dst` destination dir path `$name` new file name (optionaly) Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov Naoki Sawada Overrides `elFinderVolumeDriver::copy()`
`protected boolean`	# `remove( string $path, boolean $force = false )` Remove file/ recursive remove dir. Remove file/ recursive remove dir. Parameters `$path` file path `$force` try to remove even if file locked Returns boolean Throws `elFinderAbortException` Author Dmitry (dio) Levashov Naoki Sawada Overrides `elFinderVolumeDriver::remove()`
`protected string\|false`	# `createTmb( string $path, $stat )` Create thumnbnail and return it's URL on success. Create thumnbnail and return it's URL on success. Parameters `$path` file path `$stat` Returns string\|false Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov Naoki Sawada Overrides `elFinderVolumeDriver::createTmb()`
`protected string`	# `tmbname( array $stat )` Return thumbnail file name for required file. Return thumbnail file name for required file. Parameters `$stat` file stat Returns string Author Dmitry (dio) Levashov Overrides `elFinderVolumeDriver::tmbname()`
`protected string`	# `getSharedWebContentLink( object $raw )` Return content URL. Return content URL. Parameters `$raw` data Returns string Author Naoki Sawada
`public string`	# `getContentUrl( string $hash, array $options = array() )` Return content URL. Return content URL. Parameters `$hash` file hash `$options` options Returns string Throws Exception Author Naoki Sawada Overrides `elFinderVolumeDriver::getContentUrl()`
`protected string`	# `_dirname( string $path )` Return parent directory path. Return parent directory path. Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_basename( string $path )` Return file name. Return file name. Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_joinPath( string $dir, string $name )` Join dir name and file name and retur full path. Join dir name and file name and retur full path. Parameters `$dir` `$name` Returns string Author Dmitry (dio) Levashov
`protected string`	# `_normpath( string $path )` Return normalized path, this works the same as os.path.normpath() in Python. Return normalized path, this works the same as os.path.normpath() in Python. Parameters `$path` path Returns string Author Troex Nevelin
`protected string`	# `_relpath( string $path )` Return file path related to root dir. Return file path related to root dir. Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_abspath( string $path )` Convert path related to root dir into real path. Convert path related to root dir into real path. Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_path( string $path )` Return fake path started from root dir. Return fake path started from root dir. Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected boolean`	# `_inpath( string $path, string $parent )` Return true if $path is children of $parent. Return true if $path is children of $parent. Parameters `$path` path to check `$parent` parent path Returns boolean Author Dmitry (dio) Levashov
`protected 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. 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 `$path` file path Returns array\|false Throws Exception Author Dmitry (dio) Levashov
`protected boolean`	# `_subdirs( string $path )` Return true if path is dir and has at least one childs directory. Return true if path is dir and has at least one childs directory. Parameters `$path` dir path Returns boolean Throws Exception Author Dmitry (dio) Levashov
`protected string`	# `_dimensions( string $path, string $mime )` Return object width and height Ususaly used for images, but can be realize for video etc... Return object width and height Ususaly used for images, but can be realize for video etc... Parameters `$path` file path `$mime` file mime type Returns string Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `_scandir( string $path )` Return files list in directory. Return files list in directory. Parameters `$path` dir path Returns array Throws Exception Author Dmitry (dio) Levashov Cem (DiscoFever)
`protected resource\|false`	# `_fopen( string $path, string $mode = 'rb' )` Open file and return file pointer. Open file and return file pointer. Parameters `$path` file path `$mode` Returns resource\|false Author Dmitry (dio) Levashov
`protected`	# `_fclose( resource $fp, string $path = '' )` Close opened file. Close opened file. Parameters `$fp` file pointer `$path` Author Dmitry (dio) Levashov
`protected string\|boolean`	# `_mkdir( string $path, string $name )` Create dir and return created dir path or false on failed. Create dir and return created dir path or false on failed. Parameters `$path` parent dir path `$name` new directory name Returns string\|boolean Author Dmitry (dio) Levashov
`protected string\|boolean`	# `_mkfile( string $path, string $name )` Create file and return it's path or false on failed. Create file and return it's path or false on failed. Parameters `$path` parent dir path `$name` new file name Returns string\|boolean Author Dmitry (dio) Levashov
`protected boolean`	# `_symlink( string $target, string $path, string $name )` Create symlink. FTP driver does not support symlinks. Create symlink. FTP driver does not support symlinks. Parameters `$target` link target `$path` symlink path `$name` symlink name Returns boolean Author Dmitry (dio) Levashov
`protected string\|false`	# `_copy( string $source, string $targetDir, string $name )` Copy file into another file. Copy file into another file. Parameters `$source` source file path `$targetDir` target directory path `$name` new file name Returns string\|false Author Dmitry (dio) Levashov
`protected string\|boolean`	# `_move( string $source, string $targetDir, string $name )` Move file into another parent dir. Return new file path or false. Move file into another parent dir. Return new file path or false. Parameters `$source` source file path `$targetDir` $target target dir path `$name` file name Returns string\|boolean Author Dmitry (dio) Levashov
`protected boolean`	# `_unlink( string $path )` Remove file. Remove file. Parameters `$path` file path Returns boolean Author Dmitry (dio) Levashov
`protected boolean`	# `_rmdir( string $path )` Remove dir. Remove dir. Parameters `$path` dir path Returns boolean Author Dmitry (dio) Levashov
`protected boolean\|string`	# `_save( resource $fp, string $path, string $name, array $stat )` Create new file and write into it from file pointer. Return new file path or false on error. Create new file and write into it from file pointer. Return new file path or false on error. Parameters `$fp` file pointer `$path` $dir target dir path `$name` file name `$stat` file stat (required by some virtual fs) Returns boolean\|string Author Dmitry (dio) Levashov
`protected string\|false`	# `_getContents( string $path )` Get file contents. Get file contents. Parameters `$path` file path Returns string\|false Author Dmitry (dio) Levashov
`protected boolean`	# `_filePutContents( string $path, string $content )` Write a string to a file. Write a string to a file. Parameters `$path` file path `$content` new file content Returns boolean Author Dmitry (dio) Levashov
`protected`	# `_checkArchivers( )` Detect available archivers. Detect available archivers.
`protected boolean`	# `_chmod( string $path, string $mode )` chmod implementation. chmod implementation. Parameters `$path` file path `$mode` octal string such as '0755' Returns boolean
`protected true`	# `_extract( string $path, array $arc )` Extract files from archive. Extract files from archive. Parameters `$path` archive path `$arc` archiver command and arguments (same as in $this->archivers) Returns true Author Dmitry (dio) Levashov, Alexey Sukhotin
`protected string\|boolean`	# `_archive( string $dir, array $files, string $name, array $arc )` Create archive and return its path. Create archive and return its path. Parameters `$dir` target dir `$files` files names list `$name` archive name `$arc` archiver options Returns string\|boolean Author Dmitry (dio) Levashov, Alexey Sukhotin

Methods inherited from elFinderVolumeDriver
abspathCE(), addError(), added(), allowCreate(), allowPutMime(), archive(), attr(), basenameCE(), canCreateTmb(), canResize(), checkExtractItems(), childsByAttr(), chmod(), clearSessionCache(), clearcache(), clearcaches(), clearstatcache(), close(), closest(), closestByAttr(), commandDisabled(), convEnc(), convEncIn(), convEncOut(), copyFrom(), copyFromAllowed(), countSize(), crypt(), decode(), defaultPath(), delTree(), dimensions(), dir(), dirnameCE(), doSearch(), driverId(), duplicate(), encode(), error(), extract(), fcloseCE(), ffmpegToImg(), file(), fopenCE(), fstat(), gdImage(), gdImageBackground(), gdImageCreate(), getArchivers(), getContents(), getExtentionByMime(), getFullPath(), getHash(), getImageSize(), getItemsInHand(), getMimeTable(), getOption(), getOptionsPlugin(), getPath(), getRootPath(), getRootStatExtra(), getRootstatCachekey(), getScandir(), getSession(), getSubstituteImgLink(), getTempFile(), getTempLinkInfo(), getTempPath(), getUploadMaxSize(), getUploadTaget(), getWorkFile(), gettmb(), gettree(), id(), imageMagickConvertPrepare(), imageUtil(), imagickImage(), imgCrop(), imgResize(), imgRotate(), imgSquareFit(), inpathCE(), isMyReload(), isReadable(), isSameType(), isUploadableByName(), joinPathCE(), loadMimeTypes(), localFindSymlinks(), localMoveRecursive(), localRmdirRecursive(), localScandir(), ls(), makeArchive(), mimeAccepted(), mimeTypeNormalize(), mimetype(), mimetypeInternalDetect(), mkdir(), mkfile(), mount(), move(), nameAccepted(), normpathCE(), open(), options(), parents(), paste(), path(), procExec(), putContents(), realpath(), relpathCE(), remoteArchive(), removed(), rename(), resetRemoved(), resetResultStat(), resize(), rm(), rmTmb(), rmdirRecursive(), root(), saveCE(), saveSessionCache(), scandir(), scandirCE(), search(), searchMatchName(), sessionRestart(), setError(), setMimesFilter(), setNeedOnline(), setSession(), setUploadOverwrite(), size(), stat(), stripos(), subdirs(), subdirsCE(), symlinkCE(), tmb(), tmpfile(), tree(), uncrypt(), uniqueName(), unpackArchive(), updateCache(), updateSubdirsCache(), upload(), zipArchiveUnzip(), zipArchiveZip(), zipdl()

Magic methods inherited from elFinderVolumeDriver
`netmountPrepare(), postNetmount()`

Constants summary
`string`	`API_URL`	# `'https://api.box.com/2.0'`
`string`	`AUTH_URL`	# `'https://account.box.com/api/oauth2/authorize'`
`string`	`TOKEN_URL`	# `'https://api.box.com/oauth2/token'`
`string`	`UPLOAD_URL`	# `'https://upload.box.com/api/2.0'`
`string`	`FETCHFIELDS` Fetch fields list. Fetch fields list.	# `'type,id,name,created_at,modified_at,description,size,parent,permissions,file_version,shared_link'`

Properties summary
`protected string`	`$driverId` Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id. Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id.	# `'bd'`
`protected object`	`$token` Box.com token object. Box.com token object.	# `null`
`protected string`	`$tmp` Directory for tmp files If not set driver will try to use tmbDir as tmpDir. Directory for tmp files If not set driver will try to use tmbDir as tmpDir.	# `''`
`public string`	`$netMountKey` Net mount key. Net mount key.	# `''`
`protected array`	`$HasdirsCache` hasCache by folders. hasCache by folders.	# `array()`

Properties inherited from elFinderVolumeDriver
$ARGS, $URL, $access, $added, $archivers, $attributes, $cache, $cryptLib, $defaults, $dirnameValidator, $dirsCache, $disabled, $disabledGetUrl, $doSearchCurrentQuery, $encoding, $error, $extractToNewdir, $finfo, $getMaxSize, $id, $imgConverter, $imgLib, $maxArcFilesSize, $mimeDetect, $mimetypes, $mounted, $nameValidator, $needOnline, $onlyMimes, $options, $removed, $root, $rootModified, $rootName, $searchStart, $separator, $separatorForHash, $session, $sessionCache, $sessionCaching, $startPath, $subdirsCache, $systemRoot, $tmbPath, $tmbPathWritable, $tmbSize, $tmbURL, $tmpLinkPath, $tmpLinkUrl, $today, $treeDeep, $uploadAllow, $uploadDeny, $uploadMaxSize, $uploadOrder, $uploadOverwrite, $yesterday

Classes

Interfaces

Exceptions

Functions

Class elFinderVolumeBox

Author

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Author

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Author

Parameters

Returns

Returns

Overrides

Returns

Throws

Author

Overrides

Throws

Author

Overrides

Author

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Author

Overrides

Parameters

Returns

Throws

Author

Overrides

Parameters

Returns

Throws

Author

Overrides

Parameters

Returns

Throws

Author

Overrides

Parameters

Returns

Author

Overrides

Parameters