Documentation

FileUpload extends FormWidgetBase
in package
Uses FormModelSaver, FormModelWidget

File upload field Renders a form file uploader field.

Supported options:

  • mode: image-single, image-multi, file-single, file-multi
  • upload-label: Add file
  • empty-label: No file uploaded
Tags
author

Alexey Bobkov, Samuel Georges

Table of Contents

$alias  : string
$assetPath  : string
$attachOnUpload  : bool
$config  : object
$data  : array<string|int, mixed>
$fileTypes  : mixed
$imageHeight  : int
$imageWidth  : int
$implement  : array<string|int, mixed>
$layout  : string
$maxFilesize  : mixed
$mimeTypes  : mixed
$model  : Model
$previewMode  : bool
$prompt  : string
$sessionKey  : string
$showLabels  : bool
$suppressLayout  : bool
$thumbOptions  : array<string|int, mixed>
$useCaption  : bool
$vars  : array<string|int, mixed>
$assets  : array<string|int, mixed>
$configFormWidget  : Form
$configPath  : string
$controller  : Controller
$defaultAlias  : mixed
$extendableCallbacks  : array<string|int, mixed>
$extendableGuardProperties  : bool
$extendableStaticMethods  : array<string|int, mixed>
$extensionData  : array<string|int, mixed>
$fatalError  : string
$fieldName  : string
$formField  : FormField
$layoutPath  : string
$modelsToSave  : array<string|int, mixed>
$parentForm  : Form
$valueFrom  : string
$viewPath  : string|array<string|int, mixed>
__call()  : mixed
__callStatic()  : mixed
__construct()  : mixed
Constructor
__get()  : mixed
__set()  : mixed
addCss()  : void
Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
addDynamicMethod()  : mixed
Programmatically adds a method to the extendable class
addDynamicProperty()  : mixed
Programmatically adds a property to the extendable class
addJs()  : void
Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
addRss()  : void
Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
addViewPath()  : void
Prepends a path on the available view path locations.
asExtension()  : mixed
Short hand for `getClassExtension()` method, except takes the short extension name, example:
bindToController()  : void
Binds a widget to the controller for safe use.
clearExtendedClasses()  : void
Clear the list of extended classes so they will be re-extended.
combineAssets()  : string
Run the provided assets through the Asset Combiner
extend()  : mixed
extendableCall()  : mixed
Magic method for `__call()`
extendableCallStatic()  : mixed
Magic method for `__callStatic()`
extendableConstruct()  : mixed
This method should be called as part of the constructor.
extendableExtendCallback()  : void
Helper method for `::extend()` static method
extendableGet()  : string
Magic method for `__get()`
extendableSet()  : string
Magic method for `__set()`
extendClassWith()  : void
Dynamically extend a class with a specified behavior
fireSystemEvent()  : mixed
Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.
fireViewEvent()  : string
Special event function used for extending within view files, allowing HTML to be injected multiple times.
flushAssets()  : void
Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.
getAcceptedFileTypes()  : string
Returns the specified accepted file types, or the default based on the mode. Image mode will return: - jpg,jpeg,bmp,png,gif,svg
getAssetPath()  : string
Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.
getAssetPaths()  : array<string|int, mixed>
Returns an array of all registered asset paths.
getClassExtension()  : mixed
Returns a behavior object from an extendable class, example:
getClassMethods()  : array<string|int, mixed>
Get a list of class methods, extension equivalent of get_class_methods()
getConfig()  : string
Safe accessor for configuration values.
getConfigFormWidget()  : void
Get the instantiated config Form widget
getConfigPath()  : string
Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.
getController()  : mixed
Returns the controller using this widget.
getDynamicProperties()  : array<string|int, mixed>
Returns all dynamic properties and their values
getEventHandler()  : string
Returns a fully qualified event handler name for this widget.
getFatalError()  : string
getFieldName()  : string
Returns the HTML element field name for this widget, used for capturing user input, passed back to the getSaveValue method when saving.
getId()  : string
Returns a unique ID for this widget. Useful in creating HTML markup.
getLoadValue()  : string
Returns the value for this form field, supports nesting via HTML array.
getParentForm()  : Form|null
Retrieve the parent form for this formwidget
getSaveValue()  : string
Process the postback value for this widget. If the value is omitted from postback data, it will be NULL, otherwise it will be an empty string.
getViewPath()  : string
Locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.
getViewPaths()  : array<string|int, mixed>
Returns the active view path locations.
guessConfigPath()  : string
Guess the package path for the called class.
guessConfigPathFrom()  : string
Guess the package path from a specified class.
guessViewPath()  : string
Guess the package path for the called class.
guessViewPathFrom()  : string
Guess the package path from a specified class.
handleError()  : mixed
Sets standard page variables in the case of a controller error.
hasAssetsDefined()  : bool
Returns true if assets any have been added.
hasFatalError()  : bool
init()  : mixed
isClassExtendedWith()  : bool
Check if extendable class is extended with a behavior object
makeAssets()  : string
Outputs `<link>` and `<script>` tags to load assets previously added with addJs and addCss method calls
makeConfig()  : array<string|int, mixed>|stdClass
Reads the contents of the supplied file and applies it to this object.
makeConfigFromArray()  : stdClass
Makes a config object from an array, making the first level keys properties of a new object.
makeFileContents()  : string
Includes a file path using output buffering.
makeFormWidget()  : FormWidgetBase
Makes a form widget object with the supplied form field and widget configuration.
makeLayout()  : mixed
Render a layout.
makeLayoutPartial()  : string
Renders a layout partial
makePartial()  : mixed
Render a partial file contents located in the views folder.
makeView()  : string
Loads a view with the name specified. Applies layout if its name is provided by the parent object.
makeViewContent()  : string
Renders supplied contents inside a layout.
makeWidget()  : mixed|WidgetBase
Makes a widget object with the supplied configuration file.
mergeConfig()  : stdClass
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
methodExists()  : bool
Checks if a method exists, extension equivalent of method_exists()
onLoadAttachmentConfig()  : mixed
Loads the configuration form for an attachment, allowing title and description to be set.
onRemoveAttachment()  : mixed
Removes a file attachment.
onSaveAttachmentConfig()  : mixed
Commit the changes of the attachment configuration form.
onSortAttachments()  : mixed
Sorts file attachments.
onUpload()  : mixed
Upload handler for the server-side processing of uploaded files
propertyExists()  : bool
Checks if a property exists, extension equivalent of `property_exists()`
render()  : mixed
resetSession()  : void
Resets all session data related to this widget.
resolveModelAttribute()  : array<string|int, mixed>
Returns the final model and attribute name of a nested HTML array attribute.
addAsset()  : mixed
Adds the provided asset to the internal asset collections
decorateFileAttributes()  : File
Adds the bespoke attributes used internally by this widget.
deferPurgedSaveAttributes()  : void
Removes an array of attributes from the model. If the model implements the Purgeable trait, this is preferred over the internal logic.
extendableIsAccessible()  : bool
Checks if a property is accessible, property equivalent of `is_callable()`
extensionExtractMethods()  : void
Extracts the available methods from a behavior and adds it to the list of callable methods.
fillFromConfig()  : void
Transfers config values stored inside the $config property directly on to the root object properties. If no properties are defined all config will be transferred if it finds a matching property.
getAssetEntryBuildPath()  : string
Internal helper, attaches a build code to an asset path
getAssetScheme()  : string
Internal helper, get asset scheme
getCssDimensions()  : string
Returns the CSS dimensions for the uploaded image, uses auto where no dimension is provided.
getDisplayMode()  : string
Returns the display mode for the file upload. Eg: file-multi, image-single, etc.
getFileList()  : mixed
getFileRecord()  : File|false
Get the file record for this request, returns false if none available
getLocalPath()  : mixed
getPromptText()  : string
Returns the escaped and translated prompt text to display according to the type.
getRelationModel()  : Relation
Returns the model of a relation type, supports nesting via HTML array.
getRelationObject()  : Relation
Returns the value as a relation object from the model, supports nesting via HTML array.
getRelationType()  : Relation
Returns the value as a relation type from the model, supports nesting via HTML array.
getSession()  : string
Retrieves a widget related key/value pair from session data.
getUploadMaxFilesize()  : int
Return max upload filesize in Mb
handleViewException()  : void
Handle a view exception.
loadAssets()  : mixed
makeSessionId()  : string
Returns a unique session identifier for this widget and controller action.
prepareModelsToSave()  : array<string|int, mixed>
Takes a model and fills it with data from a multidimensional array.
prepareVars()  : mixed
Prepares the view data
putSession()  : void
Saves a widget related key/value pair in to session data.
removeDuplicates()  : void
Removes duplicate assets from the entire collection.
setModelAttributes()  : void
Sets a data collection to a model attributes, relations are also set.

Properties

$alias

public string $alias

Defined alias used for this widget.

$assetPath

public string $assetPath

Specifies a path to the asset directory.

$attachOnUpload

public bool $attachOnUpload = false

Automatically attaches the uploaded file on upload if the parent record exists instead of using deferred binding to attach on save of the parent record. Defaults to false.

$config

public object $config

Supplied configuration.

$data

public array<string|int, mixed> $data

Dataset containing field values, if none supplied model should be used.

$fileTypes

public mixed $fileTypes = false

Collection of acceptable file types.

$imageHeight

public int $imageHeight

Preview image height

$imageWidth

public int $imageWidth

Preview image width

$implement

public array<string|int, mixed> $implement

Extensions implemented by this class.

$layout

public string $layout

Layout to use for the view.

$maxFilesize

public mixed $maxFilesize

Max file size.

$mimeTypes

public mixed $mimeTypes = false

Collection of acceptable mime types.

$previewMode

public bool $previewMode = false

Render this form with uneditable preview data.

$prompt

public string $prompt

Prompt text to display for the upload button.

$sessionKey

public string $sessionKey

Active session key, used for editing forms and deferred bindings.

$showLabels

public bool $showLabels = true

Determines if this form field should display comments and labels.

$suppressLayout

public bool $suppressLayout = false

Prevents the use of a layout.

$thumbOptions

public array<string|int, mixed> $thumbOptions = ['mode' => 'crop', 'extension' => 'auto']

Options used for generating thumbnails.

$useCaption

public bool $useCaption = true

Allow the user to set a caption.

$vars

public array<string|int, mixed> $vars = []

A list of variables to pass to the page.

$assets

protected array<string|int, mixed> $assets = ['js' => [], 'css' => [], 'rss' => []]

Collection of assets to display in the layout.

$configFormWidget

protected Form $configFormWidget

The embedded form for modifying the properties of the selected file

$configPath

protected string $configPath

Specifies a path to the config directory.

$defaultAlias

protected mixed $defaultAlias = 'fileupload'
Tags
inheritDoc

$extendableCallbacks

protected static array<string|int, mixed> $extendableCallbacks = []

Used to extend the constructor of an extendable class. Eg:

Class::extend(function($obj) { })

$extendableGuardProperties

protected static bool $extendableGuardProperties = true

Indicates if dynamic properties can be created.

$extendableStaticMethods

protected static array<string|int, mixed> $extendableStaticMethods = []

Collection of static methods used by behaviors.

$extensionData

protected array<string|int, mixed> $extensionData = ['extensions' => [], 'methods' => [], 'dynamicMethods' => [], 'dynamicProperties' => []]

Class reflection information, including behaviors.

$fatalError

protected string $fatalError

Object used for storing a fatal error.

$layoutPath

protected string $layoutPath

Specifies a path to the layout directory.

$modelsToSave

protected array<string|int, mixed> $modelsToSave = []

List of prepared models that require saving.

$parentForm

protected Form $parentForm = null

The parent form that contains this field

$valueFrom

protected string $valueFrom

Model attribute to get/set value from.

$viewPath

protected string|array<string|int, mixed> $viewPath

Specifies a path to the views directory.

Methods

__call()

public __call(mixed $name, mixed $params) : mixed
Parameters
$name : mixed
$params : mixed
Return values
mixed —

__callStatic()

public static __callStatic(mixed $name, mixed $params) : mixed
Parameters
$name : mixed
$params : mixed
Return values
mixed —

__construct()

Constructor

public __construct() : mixed
Return values
mixed —

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed —

addCss()

Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

public addCss(string $name[, array<string|int, mixed> $attributes = [] ]) : void
Parameters
$name : string

Specifies a path (URL) to the script.

$attributes : array<string|int, mixed> = []

Adds extra HTML attributes to the asset link.

Return values
void —

addDynamicMethod()

Programmatically adds a method to the extendable class

public addDynamicMethod(string $dynamicName, callable $method[, string $extension = null ]) : mixed
Parameters
$dynamicName : string
$method : callable
$extension : string = null
Return values
mixed —

addDynamicProperty()

Programmatically adds a property to the extendable class

public addDynamicProperty(string $dynamicName[, string $value = null ]) : mixed
Parameters
$dynamicName : string
$value : string = null
Return values
mixed —

addJs()

Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

public addJs(string $name[, array<string|int, mixed> $attributes = [] ]) : void
Parameters
$name : string

Specifies a path (URL) to the script.

$attributes : array<string|int, mixed> = []

Adds extra HTML attributes to the asset link.

Return values
void —

addRss()

Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

public addRss(string $name[, array<string|int, mixed> $attributes = [] ]) : void
Parameters
$name : string

Specifies a path (URL) to the RSS channel

$attributes : array<string|int, mixed> = []

Adds extra HTML attributes to the asset link.

Return values
void —

addViewPath()

Prepends a path on the available view path locations.

public addViewPath(string|array<string|int, mixed> $path) : void
Parameters
$path : string|array<string|int, mixed>
Return values
void —

asExtension()

Short hand for `getClassExtension()` method, except takes the short extension name, example:

public asExtension(string $shortName) : mixed

$this->asExtension('FormController')

Parameters
$shortName : string
Return values
mixed —

bindToController()

Binds a widget to the controller for safe use.

public bindToController() : void
Return values
void —

clearExtendedClasses()

Clear the list of extended classes so they will be re-extended.

public static clearExtendedClasses() : void
Return values
void —

combineAssets()

Run the provided assets through the Asset Combiner

public combineAssets(array<string|int, mixed> $assets[, string $localPath = '' ]) : string
Parameters
$assets : array<string|int, mixed>

Collection of assets

$localPath : string = ''

Prefix all assets with this path (optional)

Return values
string —

extend()

public static extend(callable $callback) : mixed
Parameters
$callback : callable
Return values
mixed —

extendableCall()

Magic method for `__call()`

public extendableCall(string $name[, array<string|int, mixed> $params = null ]) : mixed
Parameters
$name : string
$params : array<string|int, mixed> = null
Return values
mixed —

extendableCallStatic()

Magic method for `__callStatic()`

public static extendableCallStatic(string $name[, array<string|int, mixed> $params = null ]) : mixed
Parameters
$name : string
$params : array<string|int, mixed> = null
Return values
mixed —

extendableConstruct()

This method should be called as part of the constructor.

public extendableConstruct() : mixed
Return values
mixed —

extendableExtendCallback()

Helper method for `::extend()` static method

public static extendableExtendCallback(callable $callback) : void
Parameters
$callback : callable
Return values
void —

extendableGet()

Magic method for `__get()`

public extendableGet(string $name) : string
Parameters
$name : string
Return values
string —

extendableSet()

Magic method for `__set()`

public extendableSet(string $name, string $value) : string
Parameters
$name : string
$value : string
Return values
string —

extendClassWith()

Dynamically extend a class with a specified behavior

public extendClassWith(string $extensionName) : void
Parameters
$extensionName : string
Return values
void —

fireSystemEvent()

Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.

public fireSystemEvent(string $event[, array<string|int, mixed> $params = [] ][, bool $halt = true ]) : mixed

For example:

$this->fireSystemEvent('backend.list.myEvent', ['my value']);

Is equivalent to:

$this->fireEvent('list.myEvent', ['myvalue'], true);

Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);
Parameters
$event : string

Event name

$params : array<string|int, mixed> = []

Event parameters

$halt : bool = true

Halt after first non-null result

Return values
mixed —

fireViewEvent()

Special event function used for extending within view files, allowing HTML to be injected multiple times.

public fireViewEvent(string $event[, array<string|int, mixed> $params = [] ]) : string

For example:

fireViewEvent('backend.auth.extendSigninView') ?>
Parameters
$event : string

Event name

$params : array<string|int, mixed> = []

Event parameters

Return values
string —

flushAssets()

Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.

public flushAssets() : void
Return values
void —

getAcceptedFileTypes()

Returns the specified accepted file types, or the default based on the mode. Image mode will return: - jpg,jpeg,bmp,png,gif,svg

public getAcceptedFileTypes([mixed $includeDot = false ]) : string
Parameters
$includeDot : mixed = false
Return values
string —

getAssetPath()

Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.

public getAssetPath(string $fileName[, string $assetPath = null ]) : string
Parameters
$fileName : string

File to load.

$assetPath : string = null

Explicitly define an asset path.

Return values
string —

Relative path to the asset file.

getAssetPaths()

Returns an array of all registered asset paths.

public getAssetPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getClassExtension()

Returns a behavior object from an extendable class, example:

public getClassExtension(string $name) : mixed

$this->getClassExtension('Backend.Behaviors.FormController')

Parameters
$name : string

Fully qualified behavior name

Return values
mixed —

getClassMethods()

Get a list of class methods, extension equivalent of get_class_methods()

public getClassMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

Safe accessor for configuration values.

public getConfig(string $name[, string $default = null ]) : string
Parameters
$name : string

Config name, supports array names like "field[key]"

$default : string = null

Default value if nothing is found

Return values
string —

getConfigFormWidget()

Get the instantiated config Form widget

public getConfigFormWidget() : void
Return values
void —

getConfigPath()

Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.

public getConfigPath(string $fileName[, mixed $configPath = null ]) : string
Parameters
$fileName : string

File to load.

$configPath : mixed = null

Explicitly define a config path.

Return values
string —

Full path to the config file.

getController()

Returns the controller using this widget.

public getController() : mixed
Return values
mixed —

getDynamicProperties()

Returns all dynamic properties and their values

public getDynamicProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

['property' => 'value']

getEventHandler()

Returns a fully qualified event handler name for this widget.

public getEventHandler(string $name) : string
Parameters
$name : string

The ajax event handler name.

Return values
string —

getFatalError()

public getFatalError() : string
Return values
string —

The fatal error message

getFieldName()

Returns the HTML element field name for this widget, used for capturing user input, passed back to the getSaveValue method when saving.

public getFieldName() : string
Return values
string —

HTML element name

getId()

Returns a unique ID for this widget. Useful in creating HTML markup.

public getId([string $suffix = null ]) : string
Parameters
$suffix : string = null

An extra string to append to the ID.

Return values
string —

A unique identifier.

getLoadValue()

Returns the value for this form field, supports nesting via HTML array.

public getLoadValue() : string
Return values
string —

getParentForm()

Retrieve the parent form for this formwidget

public getParentForm() : Form|null
Return values
Form|null —

getSaveValue()

Process the postback value for this widget. If the value is omitted from postback data, it will be NULL, otherwise it will be an empty string.

public getSaveValue(mixed $value) : string
Parameters
$value : mixed

The existing value for this widget.

Tags
inheritDoc
Return values
string —

The new value for this widget.

getViewPath()

Locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.

public getViewPath(string $fileName[, mixed $viewPath = null ]) : string
Parameters
$fileName : string

File to load.

$viewPath : mixed = null

Explicitly define a view path.

Return values
string —

Full path to the view file.

getViewPaths()

Returns the active view path locations.

public getViewPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —

guessConfigPath()

Guess the package path for the called class.

public guessConfigPath([string $suffix = '' ]) : string
Parameters
$suffix : string = ''

An extra path to attach to the end

Return values
string —

guessConfigPathFrom()

Guess the package path from a specified class.

public guessConfigPathFrom(string $class[, string $suffix = '' ]) : string
Parameters
$class : string

Class to guess path from.

$suffix : string = ''

An extra path to attach to the end

Return values
string —

guessViewPath()

Guess the package path for the called class.

public guessViewPath([string $suffix = '' ][, bool $isPublic = false ]) : string
Parameters
$suffix : string = ''

An extra path to attach to the end

$isPublic : bool = false

Returns public path instead of an absolute one

Return values
string —

guessViewPathFrom()

Guess the package path from a specified class.

public guessViewPathFrom(string $class[, string $suffix = '' ][, bool $isPublic = false ]) : string
Parameters
$class : string

Class to guess path from.

$suffix : string = ''

An extra path to attach to the end

$isPublic : bool = false

Returns public path instead of an absolute one

Return values
string —

handleError()

Sets standard page variables in the case of a controller error.

public handleError(mixed $exception) : mixed
Parameters
$exception : mixed
Return values
mixed —

hasAssetsDefined()

Returns true if assets any have been added.

public hasAssetsDefined() : bool
Return values
bool —

hasFatalError()

public hasFatalError() : bool
Return values
bool —

Whether a fatal error has been set or not.

init()

public init() : mixed
Tags
inheritDoc
Return values
mixed —

isClassExtendedWith()

Check if extendable class is extended with a behavior object

public isClassExtendedWith(string $name) : bool
Parameters
$name : string

Fully qualified behavior name

Return values
bool —

makeAssets()

Outputs `<link>` and `<script>` tags to load assets previously added with addJs and addCss method calls

public makeAssets([string $type = null ]) : string
Parameters
$type : string = null

Return an asset collection of a given type (css, rss, js) or null for all.

Return values
string —

makeConfig()

Reads the contents of the supplied file and applies it to this object.

public makeConfig([array<string|int, mixed> $configFile = [] ][, array<string|int, mixed> $requiredConfig = [] ]) : array<string|int, mixed>|stdClass
Parameters
$configFile : array<string|int, mixed> = []
$requiredConfig : array<string|int, mixed> = []
Return values
array<string|int, mixed>|stdClass —

makeConfigFromArray()

Makes a config object from an array, making the first level keys properties of a new object.

public makeConfigFromArray([array<string|int, mixed> $configArray = [] ]) : stdClass
Parameters
$configArray : array<string|int, mixed> = []

Config array.

Return values
stdClass —

The config object

makeFileContents()

Includes a file path using output buffering.

public makeFileContents(string $filePath[, array<string|int, mixed> $extraParams = [] ]) : string

Ensures that vars are available.

Parameters
$filePath : string

Absolute path to the view file.

$extraParams : array<string|int, mixed> = []

Parameters that should be available to the view.

Return values
string —

makeFormWidget()

Makes a form widget object with the supplied form field and widget configuration.

public makeFormWidget(string $class[, mixed $fieldConfig = [] ][, array<string|int, mixed> $widgetConfig = [] ]) : FormWidgetBase
Parameters
$class : string

Widget class name

$fieldConfig : mixed = []

A field name, an array of config or a FormField object.

$widgetConfig : array<string|int, mixed> = []

An array of config.

Return values
FormWidgetBase —

The widget object

makeLayout()

Render a layout.

public makeLayout([string $name = null ][, array<string|int, mixed> $params = [] ][, bool $throwException = true ]) : mixed
Parameters
$name : string = null

Specifies the layout name. If this parameter is omitted, the $layout property will be used.

$params : array<string|int, mixed> = []

Parameter variables to pass to the view.

$throwException : bool = true

Throw an exception if the layout is not found

Return values
mixed —

The layout contents, or false.

makeLayoutPartial()

Renders a layout partial

public makeLayoutPartial(string $partial[, array<string|int, mixed> $params = [] ]) : string
Parameters
$partial : string

The view to load.

$params : array<string|int, mixed> = []

Parameter variables to pass to the view.

Return values
string —

The layout partial contents

makePartial()

Render a partial file contents located in the views folder.

public makePartial(string $partial[, array<string|int, mixed> $params = [] ][, bool $throwException = true ]) : mixed
Parameters
$partial : string

The view to load.

$params : array<string|int, mixed> = []

Parameter variables to pass to the view.

$throwException : bool = true

Throw an exception if the partial is not found.

Return values
mixed —

Partial contents or false if not throwing an exception.

makeView()

Loads a view with the name specified. Applies layout if its name is provided by the parent object.

public makeView(string $view) : string

The view file must be situated in the views directory, and has the extension "htm".

Parameters
$view : string

Specifies the view name, without extension. Eg: "index".

Return values
string —

makeViewContent()

Renders supplied contents inside a layout.

public makeViewContent(string $contents[, string $layout = null ]) : string
Parameters
$contents : string

The inner contents as a string.

$layout : string = null

Specifies the layout name.

Return values
string —

makeWidget()

Makes a widget object with the supplied configuration file.

public makeWidget(string $class[, array<string|int, mixed> $widgetConfig = [] ]) : mixed|WidgetBase
Parameters
$class : string

Widget class name

$widgetConfig : array<string|int, mixed> = []

An array of config.

Return values
mixed|WidgetBase —

The widget object

mergeConfig()

Merges two configuration sources, either prepared or not, and returns them as a single configuration object.

public mergeConfig(mixed $configA, mixed $configB) : stdClass
Parameters
$configA : mixed
$configB : mixed
Return values
stdClass —

The config object

methodExists()

Checks if a method exists, extension equivalent of method_exists()

public methodExists(string $name) : bool
Parameters
$name : string
Return values
bool —

onLoadAttachmentConfig()

Loads the configuration form for an attachment, allowing title and description to be set.

public onLoadAttachmentConfig() : mixed
Return values
mixed —

onRemoveAttachment()

Removes a file attachment.

public onRemoveAttachment() : mixed
Return values
mixed —

onSaveAttachmentConfig()

Commit the changes of the attachment configuration form.

public onSaveAttachmentConfig() : mixed
Return values
mixed —

onSortAttachments()

Sorts file attachments.

public onSortAttachments() : mixed
Return values
mixed —

onUpload()

Upload handler for the server-side processing of uploaded files

public onUpload() : mixed
Return values
mixed —

propertyExists()

Checks if a property exists, extension equivalent of `property_exists()`

public propertyExists(string $name) : bool
Parameters
$name : string
Return values
bool —

render()

public render() : mixed
Tags
inheritDoc
Return values
mixed —

resetSession()

Resets all session data related to this widget.

public resetSession() : void
Return values
void —

resolveModelAttribute()

Returns the final model and attribute name of a nested HTML array attribute.

public resolveModelAttribute(mixed $attribute) : array<string|int, mixed>

Eg: list($model, $attribute) = $this->resolveModelAttribute($this->valueFrom);

Parameters
$attribute : mixed
Return values
array<string|int, mixed> —

addAsset()

Adds the provided asset to the internal asset collections

protected addAsset(string $type, string $path, array<string|int, mixed> $attributes) : mixed
Parameters
$type : string

The type of the asset: 'js' || 'css' || 'rss'

$path : string

The path to the asset

$attributes : array<string|int, mixed>

The attributes for the asset

Return values
mixed —

decorateFileAttributes()

Adds the bespoke attributes used internally by this widget.

protected decorateFileAttributes(mixed $file) : File
  • thumbUrl
  • pathUrl
Parameters
$file : mixed
Return values
File —

deferPurgedSaveAttributes()

Removes an array of attributes from the model. If the model implements the Purgeable trait, this is preferred over the internal logic.

protected deferPurgedSaveAttributes(Model $model, array<string|int, mixed> $attributesToPurge) : void
Parameters
$model : Model

Model to adjust.

$attributesToPurge : array<string|int, mixed>

Attribute values to remove from the model.

Return values
void —

extendableIsAccessible()

Checks if a property is accessible, property equivalent of `is_callable()`

protected extendableIsAccessible(mixed $class, string $propertyName) : bool
Parameters
$class : mixed
$propertyName : string
Return values
bool —

extensionExtractMethods()

Extracts the available methods from a behavior and adds it to the list of callable methods.

protected extensionExtractMethods(string $extensionName, object $extensionObject) : void
Parameters
$extensionName : string
$extensionObject : object
Return values
void —

fillFromConfig()

Transfers config values stored inside the $config property directly on to the root object properties. If no properties are defined all config will be transferred if it finds a matching property.

protected fillFromConfig([array<string|int, mixed> $properties = null ]) : void
Parameters
$properties : array<string|int, mixed> = null
Return values
void —

getAssetEntryBuildPath()

Internal helper, attaches a build code to an asset path

protected getAssetEntryBuildPath(array<string|int, mixed> $asset) : string
Parameters
$asset : array<string|int, mixed>

Stored asset array

Return values
string —

getAssetScheme()

Internal helper, get asset scheme

protected getAssetScheme(string $asset) : string
Parameters
$asset : string

Specifies a path (URL) to the asset.

Return values
string —

getCssDimensions()

Returns the CSS dimensions for the uploaded image, uses auto where no dimension is provided.

protected getCssDimensions([string $mode = null ]) : string
Parameters
$mode : string = null
Return values
string —

getDisplayMode()

Returns the display mode for the file upload. Eg: file-multi, image-single, etc.

protected getDisplayMode() : string
Return values
string —

getFileList()

protected getFileList() : mixed
Return values
mixed —

getFileRecord()

Get the file record for this request, returns false if none available

protected getFileRecord() : File|false
Return values
File|false —

getLocalPath()

protected getLocalPath(string $relativePath) : mixed
Parameters
$relativePath : string
Return values
mixed —

getPromptText()

Returns the escaped and translated prompt text to display according to the type.

protected getPromptText() : string
Return values
string —

getRelationModel()

Returns the model of a relation type, supports nesting via HTML array.

protected getRelationModel() : Relation
Return values
Relation —

getRelationObject()

Returns the value as a relation object from the model, supports nesting via HTML array.

protected getRelationObject() : Relation
Return values
Relation —

getRelationType()

Returns the value as a relation type from the model, supports nesting via HTML array.

protected getRelationType() : Relation
Return values
Relation —

getSession()

Retrieves a widget related key/value pair from session data.

protected getSession([string $key = null ][, string $default = null ]) : string
Parameters
$key : string = null

Unique key for the data store.

$default : string = null

A default value to use when value is not found.

Return values
string —

getUploadMaxFilesize()

Return max upload filesize in Mb

protected getUploadMaxFilesize() : int
Return values
int —

handleViewException()

Handle a view exception.

protected handleViewException(Exception $e, int $obLevel) : void
Parameters
$e : Exception
$obLevel : int
Return values
void —

loadAssets()

protected loadAssets() : mixed
Tags
inheritDoc
Return values
mixed —

makeSessionId()

Returns a unique session identifier for this widget and controller action.

protected makeSessionId() : string
Return values
string —

prepareModelsToSave()

Takes a model and fills it with data from a multidimensional array.

protected prepareModelsToSave(Model $model, array<string|int, mixed> $saveData) : array<string|int, mixed>

If an attribute is found to be a relationship, that relationship is also filled.

$modelsToSave = $this->prepareModelsToSave($model, [...]);

foreach ($modelsToSave as $modelToSave) {
    $modelToSave->save();
}
Parameters
$model : Model

Model to fill.

$saveData : array<string|int, mixed>

Attribute values to fill model.

Return values
array<string|int, mixed> —

The collection of models to save.

prepareVars()

Prepares the view data

protected prepareVars() : mixed
Return values
mixed —

putSession()

Saves a widget related key/value pair in to session data.

protected putSession(string $key, string $value) : void
Parameters
$key : string

Unique key for the data store.

$value : string

The value to store.

Return values
void —

removeDuplicates()

Removes duplicate assets from the entire collection.

protected removeDuplicates() : void
Return values
void —

setModelAttributes()

Sets a data collection to a model attributes, relations are also set.

protected setModelAttributes(Model $model, array<string|int, mixed> $saveData) : void
Parameters
$model : Model

Model to fill.

$saveData : array<string|int, mixed>

Attribute values to fill model.

Return values
void —

Search results