How to create a wrapper for a js library

You are viewing revision #2 of this wiki article.
This version may not be up to date with the latest version.
You may want to view the differences to the latest version or see the changes made in this revision.

« previous (#1)next (#3) »

  1. Our example: uploadify
  2. Creating the widget
  3. Import uploadify
  4. Conclusion

In this wiki will be explained how to include a javascript library in a widget.

We will use as example uploadify, a flash/javascript plugin for file uploading.

Our example: uploadify

Let's imagine we have a page with a file field, and we want to exchange with a uploadify.

The first step is to create a widget that will replace this file field.

Creating the widget

Let's create a file in components named ZUploadify:

<?php

class ZUploadify extends CInputWidget
{

	public function run()
	{

		echo CHtml::activeFileField($this->model, $this->attribute);
	}

}

We extend CInputWidget, the base widget for input field. This masterclass give use the attributes 'model' and 'attribute'.

And instead of the file field in our form we can place:

<?php $this->widget('ZUploadify', array('model'=>$model, 'attribute'=>'file')); ?>

Excellent! Now we have a widget wich works exactly how worked CHtml::activeFileField(), we can move forward for use uploadify

Import uploadify

Following uploadify's documentation, we have to download the package and import in the web page.

Let's save the package in protected/compoments/assets for now.

Now we have to publis this directory and to include the files. All simple as:

public function run()
	{

		$assetsFolder= Yii::app()->assetManager->publish(Yii::getPathOfAlias('application.components.assets.uploadify'));
		Yii::app()->clientScript->registerCssFile($assetsFolder.'/uploadify.css');
		Yii::app()->clientScript->registerScriptFile($assetsFolder.'/swfobject.js');
		Yii::app()->clientScript->registerScriptFile($assetsFolder.'/jquery.uploadify.v2.1.4.min.js');
		Yii::app()->clientScript->registerCoreScript('jquery');

		echo CHtml::activeFileField($this->model, $this->attribute);
	}

The first instruction (assetsManger->publish) publish the directory and return the path created.

The other options publish the script and css file. Please note that we include the yii version of jquery (), not the uploadify one for avoid conflicts.

Register the script

Our objective is to register this script:

<script type="text/javascript">
$(document).ready(function() {
  $('#file_upload').uploadify({
    'uploader'  : '/uploadify/uploadify.swf',
    'script'    : '/uploadify/uploadify.php',
    'cancelImg' : '/uploadify/cancel.png',
    'folder'    : '/uploads',
    'auto'      : true
  });
});
</script>

And to reserve us the possiblity of customize it. Let's add a property options:

public $options;

And then we prepare the options like that:

$options= CJavaScript::encode(array_merge(
			array(
				'uploader'  => $assetsFolder.'/uploadify.swf',
				'script'    => $assetsFolder.'/uploadify.php',
				'cancelImg' => $assetsFolder.'/cancel.png',
				'folder'    => '/uploads',
				'auto'      => true
			),
			$this->options
		));

The options are made up by some standard options (uploader, script , cancelImg, folder and auto) that will be merged with the user defined options.

User defined options will take precedence (they are the second array in array_merge), so we will have the possiblity of override the default ones.

This options will be encoded with Cjavascript::encode(), a magic function that allow to give javascript functions as parameters, we have just to write 'js:' at the begining.

For register the script we need only the id, we can generate the id with CHtml, respecting any chouce of the user:

if (isset ($htmlOptions['id']))
			$id= $htmlOptions['id'];
		else
			$id= CHtml::activeId($this->model, $this->attribute);

And finally register the script:

Yii::app()->clientScript->registerScript($id,	"$(document).ready(function() { $('#$id').uploadify($options);});");

That's it, our uploadify widget is ready to be used.

Conclusion

In summary:

Create a widget Download the library somewhere Publish the library Include needed script/css Prepare options and register the script

Here is the complete result:

<?php

class ZUploadify extends CInputWidget
{

	public $options = array();
	public function run()
	{

		$assetsFolder= Yii::app()->assetManager->publish(Yii::getPathOfAlias('application.modules.administrator.components.assets.uploadify'));
		Yii::app()->clientScript->registerCssFile($assetsFolder.'/uploadify.css');
		Yii::app()->clientScript->registerScriptFile($assetsFolder.'/swfobject.js');
		Yii::app()->clientScript->registerScriptFile($assetsFolder.'/jquery.uploadify.v2.1.4.min.js');
		Yii::app()->clientScript->registerCoreScript('jquery');

		$options= CJavaScript::encode(array_merge(
			array(
				'uploader'  => $assetsFolder.'/uploadify.swf',
				'script'    => $assetsFolder.'/uploadify.php',
				'cancelImg' => $assetsFolder.'/cancel.png',
				'folder'    => '/uploads',
				'auto'      => true
			),
			$this->options
		));

		if (isset ($htmlOptions['id']))
			$id= $htmlOptions['id'];
		else
			$id= CHtml::activeId($this->model, $this->attribute);


		Yii::app()->clientScript->registerScript($id,	"$(document).ready(function() { $('#$id').uploadify($options);});");
		echo CHtml::activeFileField($this->model, $this->attribute, $this->htmlOptions);
	}
}

For any customization, follow the documentation of uploadify. The work of Yii framework was only to give a structure in wich easy inlcude all needed file.

16 1
21 followers
Viewed: 17 356 times
Version: Unknown (update)
Category: How-tos
Written by: zaccaria
Last updated by: Maurizio Domba Cerin
Created on: Jun 8, 2011
Last updated: 7 years ago
Update Article

Revisions

View all history

Related Articles