Class pendalf89\filemanager\widgets\FileInput

Inheritancependalf89\filemanager\widgets\FileInput » yii\widgets\InputWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\base\ViewContextInterface

Class FileInput

Basic example of usage:

<?= FileInput::widget([

 'name' => 'mediafile',
 'buttonTag' => 'button',
 'buttonName' => 'Browse',
 'buttonOptions' => ['class' => 'btn btn-default'],
 'options' => ['class' => 'form-control'],
 // Widget template
 'template' => '<div class="input-group">{input}<span class="input-group-btn">{button}</span></div>',
 // Optional, if set, only this image can be selected by user
 'thumb' => 'original',
 // Optional, if set, in container will be inserted selected image
 'imageContainer' => '.img',
 // Default to FileInput::DATA_URL. This data will be inserted in input field
 'pasteData' => FileInput::DATA_URL,
 // JavaScript function, which will be called before insert file data to input.
 // Argument data contains file data.
 // data example: [alt: "Witch with cat", description: "123", url: "/uploads/2014/12/vedma-100x100.jpeg", id: "45"]
 'callbackBeforeInsert' => 'function(e, data) {
 console.log( data );
 }',

]) ?>

This class provides filemanager usage. You can optional select all media file info to your input field. More samples of usage see on github: https://github.com/PendalF89/yii2-filemanager

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attribute string The model attribute that this widget is associated with. yii\widgets\InputWidget
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$buttonName string Button name pendalf89\filemanager\widgets\FileInput
$buttonOptions array Button html options pendalf89\filemanager\widgets\FileInput
$buttonTag string Button tag pendalf89\filemanager\widgets\FileInput
$callbackBeforeInsert string JavaScript function, which will be called before insert file data to input. pendalf89\filemanager\widgets\FileInput
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$field yii\widgets\ActiveField Active input field, which triggers this widget rendering. yii\widgets\InputWidget
$frameSrc array Selecte the frameSrc in case you use a different module name pendalf89\filemanager\widgets\FileInput
$id string ID of the widget. yii\base\Widget
$imageContainer string Optional, if set, in container will be inserted selected image pendalf89\filemanager\widgets\FileInput
$model yii\base\Model The data model that this widget is associated with. yii\widgets\InputWidget
$name string The input name. yii\widgets\InputWidget
$options array Widget html options pendalf89\filemanager\widgets\FileInput
$pasteData string This data will be inserted in input field pendalf89\filemanager\widgets\FileInput
$resetButtonName string Reset button name pendalf89\filemanager\widgets\FileInput
$resetButtonOptions array Reset button html options pendalf89\filemanager\widgets\FileInput
$resetButtonTag string Reset button tag pendalf89\filemanager\widgets\FileInput
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$template string Widget template pendalf89\filemanager\widgets\FileInput
$thumb string Optional, if set, only this image can be selected by user pendalf89\filemanager\widgets\FileInput
$value string The input value. yii\widgets\InputWidget
$view yii\web\View The view object that can be used to render views or view files. yii\base\Widget
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
afterRun() This method is invoked right after a widget is executed. yii\base\Widget
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() Begins a widget. yii\base\Widget
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\Object
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Ends a widget. yii\base\Widget
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getId() Returns the ID of the widget. yii\base\Widget
getView() Returns the view object that can be used to render views or view files. yii\base\Widget
getViewPath() Returns the directory containing the view files for this widget. yii\base\Widget
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the widget. pendalf89\filemanager\widgets\FileInput
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
render() Renders a view. yii\base\Widget
renderFile() Renders a view file. yii\base\Widget
run() Runs the widget. pendalf89\filemanager\widgets\FileInput
setId() Sets the ID of the widget. yii\base\Widget
setView() Sets the view object to be used by this widget. yii\base\Widget
trigger() Triggers an event. yii\base\Component
widget() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
hasModel() yii\widgets\InputWidget

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
DATA_ALT 'alt' pendalf89\filemanager\widgets\FileInput
DATA_DESCRIPTION 'description' pendalf89\filemanager\widgets\FileInput
DATA_ID 'id' pendalf89\filemanager\widgets\FileInput
DATA_URL 'url' pendalf89\filemanager\widgets\FileInput

Property Details

$buttonName public property

Button name

public string $buttonName 'Browse'
$buttonOptions public property

Button html options

public array $buttonOptions = ['class' => 'btn btn-default']
$buttonTag public property

Button tag

public string $buttonTag 'button'
$callbackBeforeInsert public property

JavaScript function, which will be called before insert file data to input. Argument data contains file data. data example: [alt: "Witch with cat", description: "123", url: "/uploads/2014/12/vedma-100x100.jpeg", id: "45"]

$frameSrc public property

Selecte the frameSrc in case you use a different module name

public array $frameSrc = ['/filemanager/file/filemanager']
$imageContainer public property

Optional, if set, in container will be inserted selected image

public string $imageContainer ''
$options public property

Widget html options

public array $options = ['class' => 'form-control']
$pasteData public property

This data will be inserted in input field

public string $pasteData self::DATA_URL
$resetButtonName public property

Reset button name

public string $resetButtonName '<span class="text-danger glyphicon glyphicon-remove"></span>'
$resetButtonOptions public property

Reset button html options

public array $resetButtonOptions = ['class' => 'btn btn-default']
$resetButtonTag public property

Reset button tag

public string $resetButtonTag 'button'
$template public property

Widget template

public string $template '<div class="input-group">{input}<span class="input-group-btn">{button}{reset-button}</span></div>'
$thumb public property

Optional, if set, only this image can be selected by user

public string $thumb ''

Method Details

init() public method

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

public void init ( )
run() public method

Runs the widget.

public void run ( )