class File extends Controller (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from  ApplicationAwareTrait
protected string[] $helpers

The handles of the helpers to be returned by the getHelperObjects method.

from  AbstractController
protected array $sets

The values to be sent to views.

from  AbstractController
protected string|null $action

The action to be performed.

from  AbstractController
protected Request|null $request

The current request instance.

from  AbstractController
protected array|null $parameters

The action parameters.

from  AbstractController
protected $view from  Controller
protected string $viewPath

The path to the view file (update it with the setViewPath method).

from  Controller
protected $theme from  Controller
protected $controllerActionPath from  Controller
protected $themeViewTemplate from  Controller
private File|null|false $fileToBeReplaced

The file to be replaced (if any).

private FileFolder|false $destinationFolder

The destination folder where the uploaded files should be placed.

private Page|null|false $importOriginalPage

The original page to be used when importing files (if any).

Methods

setApplication(Application $app)

Setter method for the application

__construct()

Initialize the instance.

Request
getRequest()

Get the current request instance.

setRequest(Request $request)

Set the current request instance.

requireAsset()

Add an asset required in views.

addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

set(string $key, mixed $val)

Set a value to be sent to the view.

array
getSets()

Get the values to be sent to views.

bool
shouldRunControllerTask()

Should the action be executed? Override this method to answer something different than true.

array
getHelperObjects()

Get the the helpers that will be be automatically sent to Views as variables.

mixed
get(string|null $key = null, mixed $defaultValue = null)

Get the whole $_GET array or a specific querystring value.

getTask() deprecated

No description

string|null
getAction()

Get the action to be performed.

array|null
getParameters()

Get the action parameters.

on_start()

Override this method to perform controller initializations.

on_before_render()

Override this method to do something right before the view is rendered.

isPost() deprecated

No description

mixed
post(string|null $key = null, mixed $defaultValue = null)

Get the whole $_POST array or a specific posted value.

redirect() deprecated

Redirect the clients to a specific URL/page (specify path(s) as argument(s) of this function).

RedirectResponse
buildRedirect(array|string|UrlInterface $destination, int $httpResponseCode = Response::HTTP_FOUND)

Build a response that redirects clients to a specific URL/page (specify path(s) as argument(s) of $args).

runTask(mixed $action, mixed $parameters) deprecated

No description

mixed
runAction(string $action, array $parameters = [])

Perform an action of this controller (if shouldRunControllerTask returns true).

mixed
request(string|null $key = null)

Get the whole $_REQUEST array or a specific requested value.

executeCommand(mixed $command)

Dispatches a command to the command bus.

dispatchBatch(Batch $batch)

No description

setViewObject(View $view)

No description

setTheme($mixed)

No description

getTheme()

No description

setThemeViewTemplate($template)

No description

string
getThemeViewTemplate()

Returns the wrapper file that holds the content of the view. Usually view.php.

getControllerActionPath()

No description

string
getViewPath()

Get the path to the view file.

flash($key, $value, $isHTML = false)

No description

getViewObject()

No description

action()

No description

setViewPath(string $viewPath)

Set the path to the view file.

star()

No description

rescan()

No description

rescanMultiple()

No description

approveVersion()

No description

deleteVersion()

No description

upload()

No description

getFavoriteFolders()

No description

addFavoriteFolder($folderId)

No description

removeFavoriteFolder($folderId)

No description

JsonResponse
importIncoming()

No description

JsonResponse
importRemote()

No description

duplicate()

No description

getJSON()

No description

download()

No description

doRescan(File $f)

No description

getRequestFiles($permissionKey = 'view_file_in_file_manager', $checkUUID = false)

No description

Version|null
handleUpload(string $property, int|null $index = null)

No description

File|null
getFileToBeReplaced()

Get the file instance to be replaced by the uploaded file (if any).

getDestinationFolder()

Get the destination folder where the uploaded files should be placed.

Page|null
getImportOriginalPage()

Get the original page to be used when importing files (if any).

checkExistingIncomingFiles(array $incomingFiles, Incoming $incoming)

Check that a list of strings are valid "incoming" file names.

array<string,string>
checkRemoteURlsToImport(array $urls)

Check that a list of strings are valid "incoming" file names.

string
downloadRemoteURL(string $url, string $temporaryDirectory, string $ip = null)

Download an URL to the temporary directory.

buildImportResponse(array $importedFileVersions, ErrorList $errors, bool $isReplacingFile)

No description

UploadedFile|null
getFileToImport(UploadedFile $file, bool $deleteFile)

No description

bool
isFullChunkFilePresent(string $fileUuid, string $tempPath, int $totalChunks)

No description

UploadedFile
combineFileChunks(string $fileUuid, string $tempPath, int $totalChunks, UploadedFile $originalFile)

No description

fetchDirectories()

No description

uploadComplete()

No description

createDirectory()

No description

fetchIncomingFiles()

No description

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct()

Initialize the instance.

Request getRequest()

Get the current request instance.

Return Value

Request

setRequest(Request $request)

Set the current request instance.

Parameters

Request $request

requireAsset()

Add an asset required in views.

This function accept the same parameters as the requireAsset method of the ResponseAssetGroup.

See also

ResponseAssetGroup::requireAsset

addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

Parameters

string $item

addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

Parameters

string $item

set(string $key, mixed $val)

Set a value to be sent to the view.

Parameters

string $key

The name of the value

mixed $val

The value

array getSets()

Get the values to be sent to views.

Return Value

array

bool shouldRunControllerTask()

Should the action be executed? Override this method to answer something different than true.

Return Value

bool

array getHelperObjects()

Get the the helpers that will be be automatically sent to Views as variables.

Array keys are the variable names, array values are the helper instances.

Return Value

array

mixed get(string|null $key = null, mixed $defaultValue = null)

Get the whole $_GET array or a specific querystring value.

Parameters

string|null $key

set to null to get the whole $_GET array, or a string to get a specific value in the controller sets or from the querystring parameters

mixed $defaultValue

what to return if $key is specified but it does not exist neither in the sets nor in the querystring

Return Value

mixed

getTask() deprecated

deprecated use the getAction() method

No description

string|null getAction()

Get the action to be performed.

Return Value

string|null

array|null getParameters()

Get the action parameters.

Return Value

array|null

on_start()

Override this method to perform controller initializations.

on_before_render()

Override this method to do something right before the view is rendered.

For instance, you can call $this->set('variableName', $variableValue) to send the view additional sets.

isPost() deprecated

deprecated Use $this->getRequest()->isPost();

No description

mixed post(string|null $key = null, mixed $defaultValue = null)

Get the whole $_POST array or a specific posted value.

Parameters

string|null $key

set to null to get the whole $_POST array, or a string to get a specific posted value (resulting strings will be trimmed)

mixed $defaultValue

what to return if $key is specified but it does not exist in the $_POST

Return Value

mixed

redirect() deprecated

deprecated you should return a Response instance from your methods

Redirect the clients to a specific URL/page (specify path(s) as argument(s) of this function).

RedirectResponse buildRedirect(array|string|UrlInterface $destination, int $httpResponseCode = Response::HTTP_FOUND)

Build a response that redirects clients to a specific URL/page (specify path(s) as argument(s) of $args).

Parameters

array|string|UrlInterface $destination

use an Url object to specify the destination URL, or a string/array of strings to build the URL with the resolver

int $httpResponseCode

the HTTP response code

Return Value

RedirectResponse

runTask(mixed $action, mixed $parameters) deprecated

deprecated use the runAction method

No description

Parameters

mixed $action
mixed $parameters

mixed runAction(string $action, array $parameters = [])

Perform an action of this controller (if shouldRunControllerTask returns true).

Parameters

string $action

the action to be performed

array $parameters

the action parameters

Return Value

mixed

in case the action is executed, you'll receive the result of the action, or NULL otherwise

mixed request(string|null $key = null)

Get the whole $_REQUEST array or a specific requested value.

Parameters

string|null $key

set to null to get the whole $_REQUEST array, or a string to get a specific value in $_GET or in $_POST

Return Value

mixed

executeCommand(mixed $command)

Dispatches a command to the command bus.

Parameters

mixed $command

dispatchBatch(Batch $batch)

No description

Parameters

Batch $batch

setViewObject(View $view)

No description

Parameters

View $view

setTheme($mixed)

No description

Parameters

$mixed

getTheme()

No description

setThemeViewTemplate($template)

No description

Parameters

$template

string getThemeViewTemplate()

Returns the wrapper file that holds the content of the view. Usually view.php.

Return Value

string

getControllerActionPath()

No description

string getViewPath()

Get the path to the view file.

Return Value

string

flash($key, $value, $isHTML = false)

No description

Parameters

$key
$value
$isHTML

getViewObject()

No description

action()

No description

protected Controller setViewPath(string $viewPath)

Set the path to the view file.

Parameters

string $viewPath

Return Value

Controller

star()

No description

rescan()

No description

rescanMultiple()

No description

approveVersion()

No description

deleteVersion()

No description

upload()

No description

getFavoriteFolders()

No description

addFavoriteFolder($folderId)

No description

Parameters

$folderId

removeFavoriteFolder($folderId)

No description

Parameters

$folderId

JsonResponse importIncoming()

No description

Return Value

JsonResponse

JsonResponse importRemote()

No description

Return Value

JsonResponse

duplicate()

No description

getJSON()

No description

download()

No description

protected doRescan(File $f)

No description

Parameters

File $f

protected getRequestFiles($permissionKey = 'view_file_in_file_manager', $checkUUID = false)

No description

Parameters

$permissionKey
$checkUUID

protected Version|null handleUpload(string $property, int|null $index = null)

No description

Parameters

string $property
int|null $index

Return Value

Version|null

returns NULL if the upload is chunked and we still haven't received the full file

Exceptions

UserMessageException

protected File|null getFileToBeReplaced()

Since: 8.5.0a3

Get the file instance to be replaced by the uploaded file (if any).

Return Value

File|null

Exceptions

UserMessageException

in case the file couldn't be found or it's not accessible

protected FileFolder getDestinationFolder()

Since: 8.5.0a3

Get the destination folder where the uploaded files should be placed.

Return Value

FileFolder

Exceptions

UserMessageException

in case the folder couldn't be found or it's not accessible

protected Page|null getImportOriginalPage()

Since: 8.5.0a3

Get the original page to be used when importing files (if any).

Return Value

Page|null

Exceptions

UserMessageException

in case the file couldn't be found

protected checkExistingIncomingFiles(array $incomingFiles, Incoming $incoming)

Since: 8.5.0a3

Check that a list of strings are valid "incoming" file names.

Parameters

array $incomingFiles
Incoming $incoming

Exceptions

UserMessageException

in case one or more of the specified files couldn't be found

Exception

in case of generic errors

protected array<string,string> checkRemoteURlsToImport(array $urls)

Since: 8.5.0a3

Check that a list of strings are valid "incoming" file names.

Parameters

array $urls

Return Value

array<string,string>

An array of domains and their validated IPs

Exceptions

UserMessageException

in case one or more of the specified URLs are not valid

protected string downloadRemoteURL(string $url, string $temporaryDirectory, string $ip = null)

Download an URL to the temporary directory.

Parameters

string $url
string $temporaryDirectory
string $ip

Return Value

string

the local filename

Exceptions

UserMessageException

in case of errors

protected buildImportResponse(array $importedFileVersions, ErrorList $errors, bool $isReplacingFile)

No description

Parameters

array $importedFileVersions
ErrorList $errors
bool $isReplacingFile

private UploadedFile|null getFileToImport(UploadedFile $file, bool $deleteFile)

No description

Parameters

UploadedFile $file
bool $deleteFile

output parameter that's set to true if the uploaded file should be deleted manually

Return Value

UploadedFile|null

private bool isFullChunkFilePresent(string $fileUuid, string $tempPath, int $totalChunks)

No description

Parameters

string $fileUuid
string $tempPath
int $totalChunks

Return Value

bool

private UploadedFile combineFileChunks(string $fileUuid, string $tempPath, int $totalChunks, UploadedFile $originalFile)

No description

Parameters

string $fileUuid
string $tempPath
int $totalChunks
UploadedFile $originalFile

Return Value

UploadedFile

fetchDirectories()

No description

uploadComplete()

No description

createDirectory()

No description

fetchIncomingFiles()

No description