Robot
8ebeb56d3e
Fix the demo site view to also display files. Fix the message of field type init. Fix to ensure type-agnostic comparisons by casting to CHAR in joins in dynamic get. Fix dynamic download for site area to have correct namespace.
130 lines
3.6 KiB
PHP
130 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 4th September, 2020
|
|
* @author Llewellyn van der Merwe <https://dev.vdm.io>
|
|
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
|
|
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace VDM\Joomla\Componentbuilder\File;
|
|
|
|
|
|
use VDM\Joomla\Utilities\UploadHelper;
|
|
|
|
|
|
/**
|
|
* File Handler Class
|
|
*
|
|
* @since 5.0.2
|
|
*/
|
|
final class Handler extends UploadHelper
|
|
{
|
|
/**
|
|
* Set the $useStreams property to use streams for file handling
|
|
*
|
|
* @param bool $useStreams True to use streams, false otherwise.
|
|
*
|
|
* @return self Returns the current instance to allow for method chaining.
|
|
* @since 5.0.3
|
|
*/
|
|
public function setUseStreams(bool $useStreams): self
|
|
{
|
|
static::$useStreams = $useStreams;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the $allowUnsafe property to allow or disallow unsafe file uploads.
|
|
*
|
|
* @param bool $allowUnsafe True to allow unsafe file uploads, false otherwise.
|
|
*
|
|
* @return self Returns the current instance to allow for method chaining.
|
|
* @since 5.0.3
|
|
*/
|
|
public function setAllowUnsafe(bool $allowUnsafe): self
|
|
{
|
|
static::$allowUnsafe = $allowUnsafe;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the $safeFileOptions property to define options for file safety checks.
|
|
*
|
|
* @param array $safeFileOptions An array of options for InputFilter::isSafeFile.
|
|
*
|
|
* @return self Returns the current instance to allow for method chaining.
|
|
* @since 5.0.3
|
|
*/
|
|
public function setSafeFileOptions(array $safeFileOptions): self
|
|
{
|
|
static::$safeFileOptions = $safeFileOptions;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the $enqueueError property to control error reporting behavior.
|
|
*
|
|
* @param bool $enqueueError True to enqueue error messages, false to store them in the internal error array.
|
|
*
|
|
* @return self Returns the current instance to allow for method chaining.
|
|
* @since 5.0.3
|
|
*/
|
|
public function setEnqueueError(bool $enqueueError): self
|
|
{
|
|
static::$enqueueError = $enqueueError;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the $legalFormats property to define legal file formats.
|
|
*
|
|
* @param array $legalFormats An array of allowed file formats (e.g., ['jpg', 'png']).
|
|
*
|
|
* @return self Returns the current instance to allow for method chaining.
|
|
* @since 5.0.3
|
|
*/
|
|
public function setLegalFormats(array $legalFormats): self
|
|
{
|
|
static::$legalFormats = $legalFormats;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get a file from the input based on field name and file type, then process it.
|
|
*
|
|
* @param string $field The input field name for the file upload.
|
|
* @param string $type The type of file (e.g., 'image', 'document').
|
|
* @param string|null $filter The filter to apply when uploading the file.
|
|
* @param string|null $path The directory path where the file should be saved.
|
|
*
|
|
* @return array|null File details or false on failure.
|
|
* @since 3.0.11
|
|
*/
|
|
public function getFile(string $field, string $type, string $filter = null, string $path = null): ?array
|
|
{
|
|
return static::get($field, $type, $filter, $path);
|
|
}
|
|
|
|
/**
|
|
* Get the error messages as a string.
|
|
*
|
|
* @param bool $toString The option to return errors as a string
|
|
*
|
|
* @return string|array Returns the error messages as a single concatenated string.
|
|
* @since 5.0.3
|
|
*/
|
|
public function getErrors(bool $toString = true): string|array
|
|
{
|
|
return static::getError($toString);
|
|
}
|
|
}
|
|
|