API Documentation for Yii 1.1

0 follower

CMultiFileUpload

Package	system.web.widgets
Inheritance	class CMultiFileUpload » CInputWidget » CWidget » CBaseController » CComponent
Since	1.0
Source Code	framework/web/widgets/CMultiFileUpload.php

CMultiFileUpload generates a file input that can allow uploading multiple files at a time.

This is based on the jQuery Multi File Upload plugin. The uploaded file information can be accessed via $_FILES[widget-name], which gives an array of the uploaded files. Note, you have to set the enclosing form's 'enctype' attribute to be 'multipart/form-data'.

Example:

<?php
  $this->widget('CMultiFileUpload', array(
     'model'=>$model,
     'attribute'=>'files',
     'accept'=>'jpg|gif',
     'options'=>array(
        'onFileSelect'=>'function(e, v, m){ alert("onFileSelect - "+v) }',
        'afterFileSelect'=>'function(e, v, m){ alert("afterFileSelect - "+v) }',
        'onFileAppend'=>'function(e, v, m){ alert("onFileAppend - "+v) }',
        'afterFileAppend'=>'function(e, v, m){ alert("afterFileAppend - "+v) }',
        'onFileRemove'=>'function(e, v, m){ alert("onFileRemove - "+v) }',
        'afterFileRemove'=>'function(e, v, m){ alert("afterFileRemove - "+v) }',
     ),
  ));
?>

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
accept	string	the file types that are allowed (eg "gif\|jpg").	CMultiFileUpload
actionPrefix	string	the prefix to the IDs of the actions.	CWidget
attribute	string	the attribute associated with this widget.	CInputWidget
controller	CController	Returns the controller that this widget belongs to.	CWidget
denied	string	message that is displayed when a file type is not allowed.	CMultiFileUpload
duplicate	string	message that is displayed when a file appears twice.	CMultiFileUpload
file	string	the message template for displaying the uploaded file name	CMultiFileUpload
htmlOptions	array	additional HTML options to be rendered in the input tag	CInputWidget
id	string	Returns the ID of the widget or generates a new one if requested.	CWidget
max	integer	the maximum number of files that can be uploaded.	CMultiFileUpload
model	CModel	the data model associated with this widget.	CInputWidget
name	string	the input name.	CInputWidget
options	array	additional options that can be passed to the constructor of the multifile js object.	CMultiFileUpload
owner	CBaseController	Returns the owner/creator of this widget.	CWidget
remove	string	the label for the remove button.	CMultiFileUpload
selected	string	message that is displayed when a file is selected.	CMultiFileUpload
skin	mixed	the name of the skin to be used by this widget.	CWidget
value	string	the input value	CInputWidget
viewPath	string	Returns the directory containing the view files for this widget.	CWidget

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
clientOptions	array	the javascript options	CMultiFileUpload

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CWidget
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
actions()	Returns a list of actions that are used by this widget.	CWidget
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
beginCache()	Begins fragment caching.	CBaseController
beginClip()	Begins recording a clip.	CBaseController
beginContent()	Begins the rendering of content that is to be decorated by the specified view.	CBaseController
beginWidget()	Creates a widget and executes it.	CBaseController
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
createWidget()	Creates a widget and initializes it.	CBaseController
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
endCache()	Ends fragment caching.	CBaseController
endClip()	Ends recording a clip.	CBaseController
endContent()	Ends the rendering of content.	CBaseController
endWidget()	Ends the execution of the named widget.	CBaseController
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getController()	Returns the controller that this widget belongs to.	CWidget
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()	Returns the ID of the widget or generates a new one if requested.	CWidget
getOwner()	Returns the owner/creator of this widget.	CWidget
getViewFile()	Looks for the view script file according to the view name.	CWidget
getViewPath()	Returns the directory containing the view files for this widget.	CWidget
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
init()	Initializes the widget.	CWidget
raiseEvent()	Raises an event.	CComponent
registerClientScript()	Registers the needed CSS and JavaScript.	CMultiFileUpload
render()	Renders a view.	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	Runs the widget.	CMultiFileUpload
setId()	Sets the ID of the widget.	CWidget
widget()	Creates a widget and executes it.	CBaseController

Protected Methods

Hide inherited methods

Method	Description	Defined By
getClientOptions()	Returns the javascript options	CMultiFileUpload
hasModel()	Determines whether this widget is associated with a data model.	CInputWidget
resolveNameID()		CInputWidget

Property Details

accept property

public string $accept;

the file types that are allowed (eg "gif|jpg"). Note, the server side still needs to check if the uploaded files have allowed types.

clientOptions property read-only

protected array getClientOptions()

the javascript options

denied property

public string $denied;

message that is displayed when a file type is not allowed.

duplicate property

public string $duplicate;

message that is displayed when a file appears twice.

file property (available since v1.1.3)

public string $file;

the message template for displaying the uploaded file name

max property

public integer $max;

the maximum number of files that can be uploaded. If -1, it means no limits. Defaults to -1.

options property (available since v1.1.7)

public array $options;

additional options that can be passed to the constructor of the multifile js object.

remove property

public string $remove;

the label for the remove button. Defaults to "Remove".

selected property

public string $selected;

message that is displayed when a file is selected.

Method Details

getClientOptions() method

protected array getClientOptions()
{return}	array	the javascript options

Source Code: framework/web/widgets/CMultiFileUpload.php#116 (show)


protected function getClientOptions()
{
    $options=$this->options;
    foreach(array('onFileRemove','afterFileRemove','onFileAppend','afterFileAppend','onFileSelect','afterFileSelect') as $event)
    {
        if(isset($options[$event]) && !($options[$event] instanceof CJavaScriptExpression))
            $options[$event]=new CJavaScriptExpression($options[$event]);
    }

    if($this->accept!==null)
        $options['accept']=$this->accept;
    if($this->max>0)
        $options['max']=$this->max;

    $messages=array();
    foreach(array('remove','denied','selected','duplicate','file') as $messageName)
    {
        if($this->$messageName!==null)
            $messages[$messageName]=$this->$messageName;
    }
    if($messages!==array())
        $options['STRING']=$messages;

    return $options;
}

registerClientScript() method

public void registerClientScript()

Source Code: framework/web/widgets/CMultiFileUpload.php#101 (show)


public function registerClientScript()
{
    $id=$this->htmlOptions['id'];

    $options=$this->getClientOptions();
    $options=$options===array()? '' : CJavaScript::encode($options);

    $cs=Yii::app()->getClientScript();
    $cs->registerCoreScript('multifile');
    $cs->registerScript('Yii.CMultiFileUpload#'.$id,"jQuery(\"#{$id}\").MultiFile({$options});");
}

Registers the needed CSS and JavaScript.

run() method

public void run()

Source Code: framework/web/widgets/CMultiFileUpload.php#85 (show)


public function run()
{
    list($name,$id)=$this->resolveNameID();
    if(substr($name,-2)!=='[]')
        $name.='[]';
    if(isset($this->htmlOptions['id']))
        $id=$this->htmlOptions['id'];
    else
        $this->htmlOptions['id']=$id;
    $this->registerClientScript();
    echo CHtml::fileField($name,'',$this->htmlOptions);
}

Runs the widget. This method registers all needed client scripts and renders the multiple file uploader.

User Contributed Notes