Class SystemFineUploadHandler

Base SystemFineUploadHandler class to work with ajaxfineupload.php endpoint

Upload files as specified

Do not use or reference this directly from your client-side code. Instead, this should be required via the endpoint.php or endpoint-cors.php file(s).

Direct known subclasses

SystemFineAvatarUploadHandler, SystemFineImUploadHandler

Copyright: Copyright (c) 2015-present, Widen Enterprises, Inc.
License: License (MIT)
Link: The MIT License (MIT) Copyright (c) 2015-present, Widen Enterprises, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Located at odules/system/class/fineuploadhandler.php

Methods summary
`public`	# `__construct( stdClass $claims )` XoopsFineUploadHandler constructor. XoopsFineUploadHandler constructor. Parameters `$claims` claims passed in JWT header
`public`	# `getName( )` Get the original filename Get the original filename
`public string`	# `getUploadName( )` Get the name of the uploaded file Get the name of the uploaded file Returns string
`public array`	# `combineChunks( string $uploadDirectory, string\|null $name = null )` Combine chunks into a single file Combine chunks into a single file Parameters `$uploadDirectory` upload directory `$name` name Returns array response to be json encoded and returned to client
`public array`	# `handleUpload( string $uploadDirectory, string $name = null )` Process the upload. Process the upload. Parameters `$uploadDirectory` Target directory. `$name` Overwrites the name of the file. Returns array response to be json encoded and returned to client
`protected`	# `storeUploadedFile( $target, $mimeType, $uuid )`
`public array`	# `handleDelete( string $uploadDirectory, string\|null $name = null )` Process a delete. Process a delete. Parameters `$uploadDirectory` Target directory. `$name` Overwrites the name of the file. Returns array response to be json encoded and returned to client
`protected string\|false`	# `getUniqueTargetPath( string $uploadDirectory, string $filename )` Returns a path to use with this upload. Check that the name does not exist, and appends a suffix otherwise. Returns a path to use with this upload. Check that the name does not exist, and appends a suffix otherwise. Parameters `$uploadDirectory` Target directory `$filename` The name of the file to use. Returns string\|false path or false if path could not be determined
`protected`	# `cleanupChunks( )` Deletes all file parts in the chunks folder for files uploaded more than chunksExpireIn seconds ago Deletes all file parts in the chunks folder for files uploaded more than chunksExpireIn seconds ago
`protected`	# `removeDir( string $dir )` Removes a directory and all files contained inside Removes a directory and all files contained inside Parameters `$dir`
`protected integer`	# `toBytes( string $str )` Converts a given size with units to bytes. Converts a given size with units to bytes. Parameters `$str` Returns integer
`protected boolean`	# `isInaccessible( string $directory )` Determines whether a directory can be accessed. Determines whether a directory can be accessed. is_executable() is not reliable on Windows prior PHP 5.0.0 (http://www.php.net/manual/en/function.is-executable.php) The following tests if the current OS is Windows and if so, merely checks if the folder is writable; otherwise, it checks additionally for executable status (like before). Parameters `$directory` The target directory to test access Returns boolean true if directory is NOT accessible
`protected boolean`	# `isWindows( )` Determines is the OS is Windows or not Determines is the OS is Windows or not Returns boolean

Properties summary
`public array`	`$allowedExtensions`	# `array()`
`public array`	`$allowedMimeTypes`	# `array()`
`public`	`$sizeLimit`	# `null`
`public string`	`$inputName`	# `'qqfile'`
`public string`	`$chunksFolder`	# `'chunks'`
`public float`	`$chunksCleanupProbability`	# `0.001`
`public integer`	`$chunksExpireIn`	# `604800`
`protected`	`$uploadName`	#
`public`	`$claims`	#