upload2_htmlFormWidget
extends WidgetBase
in package
implements
ParentWidgetInterface
Widget to display the selection of a file to upload.
For images upload, some attributes can be set to indicate the url of the image. The url can be forged from a selector or from a base URI. From a selector : action, parameters, and the parameter name that will contain the filename, should be given in attributes uriAction, uriActionParameters, uriActionFileParameter From a base URI : a baseURI attribute should be given, with the URL on which the filename will be append.
Tags
Interfaces, Classes and Traits
- ParentWidgetInterface
Table of Contents
- $baseURI : string
- $imgMaxHeight : mixed
- $imgMaxWidth : mixed
- $showModeForNewImage : string
- $uriAction : string
- $uriActionFileParameter : string
- parameter name containing the control value, for the jUrl object used to get the URL of the image.
- $uriActionParameters : array<string|int, mixed>
- addFinalJs() : mixed
- addJs() : mixed
- controlJsChild() : mixed
- outputControl() : mixed
- outputControlValue() : mixed
- setAttributes() : mixed
- setDefaultAttributes() : mixed
- _outputControlValue() : mixed
- displayEndChoice() : mixed
- displayEndChoiceItem() : mixed
- displayInputFile() : mixed
- displayStartChoice() : mixed
- displayStartChoiceItem() : mixed
- displayValueASFilename() : mixed
- displayValueAsImage() : mixed
- filterUploadAttributes() : mixed
- getImageURI() : mixed
- jsChoiceInternal() : mixed
- outputJs() : mixed
Properties
$baseURI
protected
string
$baseURI
= ''
base URI of the image
Tags
$imgMaxHeight
protected
mixed
$imgMaxHeight
= 0
Tags
$imgMaxWidth
protected
mixed
$imgMaxWidth
= 0
Tags
$showModeForNewImage
protected
string
$showModeForNewImage
= 'filename'
indicate how to show new image
- 'filename' to show only its filename
- 'dataURI' to load the new image with a data URI created from the temporary file. Warning: the data URI can be huge for big images. Use this mode only for little images.
- 'URL' to load the new image like the original image. It means that the application has save the image as a way that it is accessible from the web, directly in a directory (baseURI), or from a action (see uriAction*).
Tags
$uriAction
protected
string
$uriAction
= ''
the jUrl action selector used to get the URL of the image
Tags
$uriActionFileParameter
parameter name containing the control value, for the jUrl object used to get the URL of the image.
protected
string
$uriActionFileParameter
= ''
The parameter can already exist into $uriActionParameters and could contain
a %s pattern that will be replaced by the value. Else the existing parameter
value will be replaced by the new value.
parameter name containing the control value
Tags
$uriActionParameters
protected
array<string|int, mixed>
$uriActionParameters
= array()
parameters for the jUrl object used to get the URL of the image
Tags
Methods
addFinalJs()
public
addFinalJs(mixed $js) : mixed
Parameters
- $js : mixed
Tags
Return values
mixed —addJs()
public
addJs(mixed $js) : mixed
Parameters
- $js : mixed
Tags
Return values
mixed —controlJsChild()
public
controlJsChild() : mixed
Tags
Return values
mixed —outputControl()
public
outputControl() : mixed
Tags
Return values
mixed —outputControlValue()
public
outputControlValue() : mixed
Tags
Return values
mixed —setAttributes()
public
setAttributes(mixed $attr) : mixed
Parameters
- $attr : mixed
Tags
Return values
mixed —setDefaultAttributes()
public
setDefaultAttributes(mixed $attr) : mixed
Parameters
- $attr : mixed
Tags
Return values
mixed —_outputControlValue()
protected
_outputControlValue(mixed $fileName[, mixed $suffixId = '' ]) : mixed
Parameters
- $fileName : mixed
- $suffixId : mixed = ''
Tags
Return values
mixed —displayEndChoice()
protected
displayEndChoice() : mixed
Tags
Return values
mixed —displayEndChoiceItem()
protected
displayEndChoiceItem() : mixed
Tags
Return values
mixed —displayInputFile()
protected
displayInputFile(mixed $attr) : mixed
Parameters
- $attr : mixed
Tags
Return values
mixed —displayStartChoice()
protected
displayStartChoice(mixed $blockId, mixed $attrs) : mixed
Parameters
- $blockId : mixed
- $attrs : mixed
Tags
Return values
mixed —displayStartChoiceItem()
protected
displayStartChoiceItem(mixed $idItem, mixed $idRadio, mixed $attrRadio, mixed $checked, mixed $label) : mixed
Parameters
- $idItem : mixed
- $idRadio : mixed
- $attrRadio : mixed
- $checked : mixed
- $label : mixed
Tags
Return values
mixed —displayValueASFilename()
protected
displayValueASFilename(mixed $attr, mixed $filename, mixed $mimeType) : mixed
Parameters
- $attr : mixed
- $filename : mixed
- $mimeType : mixed
Tags
Return values
mixed —displayValueAsImage()
protected
displayValueAsImage(mixed $attr, mixed $url, mixed $filename, mixed $style) : mixed
Parameters
- $attr : mixed
- $url : mixed
- $filename : mixed
- $style : mixed
Tags
Return values
mixed —filterUploadAttributes()
protected
filterUploadAttributes(array<string|int, mixed> &$attr) : mixed
Parameters
- $attr : array<string|int, mixed>
Tags
Return values
mixed —getImageURI()
protected
getImageURI(mixed $fileName) : mixed
Parameters
- $fileName : mixed
Tags
Return values
mixed —jsChoiceInternal()
protected
jsChoiceInternal() : mixed
Tags
Return values
mixed —outputJs()
protected
outputJs() : mixed