All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
FilesElement Class Reference
Inheritance diagram for FilesElement:
ModelsElement DerivedElementInterface ElementActionTypeInterface Element

Public Member Functions

 getAllowDownloadOnEditable ()
 
 getAllowDownloadOnEditableDefault ()
 
- Public Member Functions inherited from Element
 __construct ($model, $attribute, $form=null, array $params=array())
 
 render ()
 
 getEditableNameIds ()
 
 getAttribute ()
 
 renderAsControlNonEditable ()
 

Static Public Member Functions

static getDisplayName ()
 
static getModelAttributeNames ()
 
static getEditableActionType ()
 
static getNonEditableActionType ()
 
static getEditableTemplateForInlineEdit ()
 
- Static Public Member Functions inherited from Element
static getDisplayName ()
 
static isReadOnly ()
 
static resolveInputNameForEditableInput ($attributeName)
 
static resolveInputNamePrefixIntoString ($inputNamePrefix)
 
static resolveInputIdPrefixIntoString ($inputIdPrefix)
 

Data Fields

const ALLOW_DOWNLOAD_ON_EDITABLE_KEY = 'allowDownloadOnEditable'
 
- Data Fields inherited from Element
 $params
 
 $editableTemplate = '<th>{label}</th><td colspan="{colspan}">{content}{error}</td>'
 
 $nonEditableTemplate = '<th>{label}</th><td colspan="{colspan}">{content}</td>'
 

Protected Member Functions

 renderControlNonEditable ()
 
 renderControlEditable ()
 
 renderError ()
 
 renderLabel ()
 
 getFormattedAttributeLabel ()
 
 getShowMaxSize ()
 
 getId ()
 
 getElementIdPostfix ()
 
 getElementModeIdForElementId ()
 
- Protected Member Functions inherited from Element
 renderLabel ()
 
 resolveIdForLabel ()
 
 getFormattedAttributeLabel ()
 
 resolveNonActiveFormFormattedLabel ($label)
 
 renderError ()
 
 renderScopedErrorId ($inputNameIdPrefix, $attribute)
 
 renderEditable ()
 
 renderNonEditable ()
 
 renderControlEditable ()
 
 renderControlNonEditable ()
 
 getColumnSpan ()
 
 getDisabledValue ()
 
 getHtmlOptions ()
 
 resolveContentTemplate ($template, $data)
 
 getEditableInputId ($attributeName=null, $relationAttributeName=null)
 
 getEditableInputName ($attributeName=null, $relationAttributeName=null)
 
 resolveInputPrefix ()
 
 resolveInputIdPrefix ()
 
 resolveInputNamePrefix ()
 
 getListViewGridId ()
 

Protected Attributes

 $elementIdPostfix = ''
 
- Protected Attributes inherited from Element
 $model
 
 $attribute
 
 $form
 

Detailed Description

User interface element for managing file attachments against a given model.

Definition at line 41 of file FilesElement.php.

Member Function Documentation

static getModelAttributeNames ( )
static

Get the attributeNames of attributes used in the derived element. For this element, there are no attributes from the model.

Returns
array - empty

Implements DerivedElementInterface.

Definition at line 137 of file FilesElement.php.

static getEditableActionType ( )
static

Gets the action type for the related model's action that is called by the select button or the autocomplete feature in the Editable render.

Implements ElementActionTypeInterface.

Definition at line 147 of file FilesElement.php.

static getNonEditableActionType ( )
static

Gets the action type for the related model's action that is called by the link in the nonEditable render.

Implements ElementActionTypeInterface.

Definition at line 152 of file FilesElement.php.

static getEditableTemplateForInlineEdit ( )
static
Returns
string content

Definition at line 174 of file FilesElement.php.

getElementIdPostfix ( )
protected

Add ElementId Postfix, which is used to distinct file uploads elements by their ids For now this feature is usefull only for comments.

Returns
string

Definition at line 203 of file FilesElement.php.

getElementModeIdForElementId ( )
protected

Used now only for comments, because in case when we have multiple comments on same page, and because user can edit comments(and remove files from comments), we need to provide unique id for each comment.

Returns
model id or null

Definition at line 217 of file FilesElement.php.


The documentation for this class was generated from the following file:
Generated on Mon Jan 27 2020 07:10:38