clevertech / YiiBooster

src/widgets/TbFileUpload.php

<?php
/**
 *## TbFileUpload class file
 *
 * @author AsgarothBelem <asgaroth.belem@gmail.com>
 * @link http://blueimp.github.com/jQuery-File-Upload/
 * @link https://github.com/Asgaroth/xupload
 *
 * @author: antonio ramirez <antonio@clevertech.biz>
 * Date: 11/5/12
 * Time: 12:46 AM
 */

Yii::import('zii.widgets.jui.CJuiInputWidget');

/**
 * Class TbFileUpload
 *
 * Modified version from the great implementation of XUpload Yii Extension
 *
 * @package booster.widgets.forms.inputs
 */
class TbFileUpload extends CJuiInputWidget
{
	private static $_callbackFnPrefix = 'fileupload';
	
	/**
	 * the url to the upload handler
	 * @var string
	 */
	public $url;

	/**
	 * set to true to use multiple file upload
	 * @var boolean
	 */
	public $multiple = false;

	/**
	 * The upload template id to display files available for upload
	 * defaults to null, meaning using the built-in template
	 */
	public $uploadTemplate;

	/**
	 * The template id to display files available for download
	 * defaults to null, meaning using the built-in template
	 */
	public $downloadTemplate;

	/**
	 * Wheter or not to preview image files before upload
	 */
	public $previewImages = true;

	/**
	 * Whether or not to add the image processing plugin
	 */
	public $imageProcessing = true;

	/**
	 * Stores callback functions JS code, reffering do jQuery-File-Upload documentation
	 * Use these values for array keys:
	 * 	- add, 
	 *  - submit, 
	 *  - send, 
	 *  - done, 
	 *  - fail, 
	 *  - always, 
	 *  - progress, 
	 *  - progressall, 
	 *  - start, 
	 *  - stop
	 * 	- change, 
	 *  - pase, 
	 *  - drop, 
	 *  - dragover, 
	 *  - chunksend, 
	 *  - chunkdone, 
	 *  - chunkfail, 
	 *  - chunkalways
	 *  Another part of callback function name will be added from code.
	 * 
	 * See link below for more details:
	 * @link https://github.com/blueimp/jQuery-File-Upload/wiki/Options#callback-options Callback options
	 * @var string[] 
	 */
	public $callbacks = array( );
        
	/**
	 * @var string name of the form view to be rendered
	 */
	public $formView = 'booster.views.fileupload.form';

	/**
	 * @var string name of the upload view to be rendered
	 */
	public $uploadView = 'booster.views.fileupload.upload';

	/**
	 * @var string name of the download view to be rendered
	 */
	public $downloadView = 'booster.views.fileupload.download';

	/**
	 * @var string name of the view to display images at bootstrap-slideshow
	 */
	public $previewImagesView = 'booster.views.gallery.preview';

	/**
	 * Widget initialization
	 */
	public function init()
	{
		if ($this->uploadTemplate === null) {
			$this->uploadTemplate = "#template-upload";
		}

		if ($this->downloadTemplate === null) {
			$this->downloadTemplate = "#template-download";
		}

		if (!isset($this->htmlOptions['enctype'])) {
			$this->htmlOptions['enctype'] = 'multipart/form-data';
		}

		parent::init();
	}

	/**
	 * Generates the required HTML and Javascript
	 */
	public function run()
	{

		list($name) = $this->resolveNameID();

		$this->htmlOptions['id'] = $this->id.'-'.($this->hasModel() ? get_class($this->model) : 'fileupload') . '-form';

		$this->options['url'] = $this->url;

		// if acceptFileTypes is not set as option, try getting it from models rules
		if (!isset($this->options['acceptFileTypes'])) {
			$fileTypes = $this->getFileValidatorProperty($this->model, $this->attribute, 'types');
			if (isset($fileTypes)) {
				$fileTypes = (preg_match(':jpg:', $fileTypes) && !preg_match(':jpe:', $fileTypes) ? preg_replace(
					':jpg:',
					'jpe?g',
					$fileTypes
				) : $fileTypes);
				$this->options['acceptFileTypes'] = 'js:/(\.)(' . preg_replace(':,:', '|', $fileTypes) . ')$/i';
			}
		}

		// if maxFileSize is not set as option, try getting it from models rules
		if (!isset($this->options['maxFileSize'])) {
			$fileSize = $this->getFileValidatorProperty($this->model, $this->attribute, 'maxSize');
			if (isset($fileSize)) {
				$this->options['maxFileSize'] = $fileSize;
			}
		}

		if ($this->multiple) {
			$this->htmlOptions["multiple"] = true;
		}

		$this->render($this->uploadView);
		$this->render($this->downloadView);
		$this->render($this->formView, array('name' => $name, 'htmlOptions' => $this->htmlOptions));

		if ($this->previewImages || $this->imageProcessing) {
			$this->render($this->previewImagesView);
		}

		$this->registerClientScript($this->htmlOptions['id']);
	}

	/**
	 * Registers and publishes required scripts
	 *
	 * @param string $id
	 */
	public function registerClientScript($id)
	{
        $booster = Booster::getBooster();
        $booster->registerAssetCss('fileupload/jquery.fileupload-ui.css');

		// Upgrade widget factory
		// @todo remove when jquery.ui 1.9+ is fully integrated into stable Yii versions
        $booster->registerAssetJs('fileupload/vendor/jquery.ui.widget.js');
		//The Templates plugin is included to render the upload/download listings
        $booster->registerAssetJs("fileupload/tmpl.min.js", CClientScript::POS_END);

		if ($this->previewImages || $this->imageProcessing) {
            $booster->registerAssetJs("fileupload/load-image.min.js", CClientScript::POS_END);
            $booster->registerAssetJs("fileupload/canvas-to-blob.min.js", CClientScript::POS_END);
			// gallery :) and one smile from me ;)
            $booster->registerAssetCss("bootstrap-image-gallery.min.css");
            $booster->registerAssetJs("bootstrap-image-gallery.min.js", CClientScript::POS_END);
		}
		//The Iframe Transport is required for browsers without support for XHR file uploads
        $booster->registerAssetJs('fileupload/jquery.iframe-transport.js');
        $booster->registerAssetJs('fileupload/jquery.fileupload.js');
		// The File Upload image processing plugin
		if ($this->imageProcessing) {
            $booster->registerAssetJs('fileupload/jquery.fileupload-ip.js');
		}
		// The File Upload file processing plugin
		if ($this->previewImages) {
            $booster->registerAssetJs('fileupload/jquery.fileupload-fp.js');
		}
		// locale
        $booster->registerAssetJs('fileupload/jquery.fileupload-locale.js');
		//The File Upload user interface plugin
        $booster->registerAssetJs('fileupload/jquery.fileupload-ui.js');

		$options = CJavaScript::encode($this->options);
		Yii::app()->clientScript->registerScript(__CLASS__ . '#' . $id, "jQuery('#{$id}').fileupload({$options}){$this->generateCallbackBindJSString()};");
	}

	/**
	 * Check for a property of CFileValidator
	 *
	 * @param CModel $model
	 * @param string $attribute
	 * @param string $property
	 *
	 * @return string property's value or null
	 */
	private function getFileValidatorProperty($model = null, $attribute = null, $property = null)
	{
		if (!isset($model, $attribute, $property)) {
			return null;
		}

		foreach ($model->getValidators($attribute) as $validator) {
			if ($validator instanceof CFileValidator) {

The class CFileValidator does not exist. Did you forget a USE statement, or did you not list all dependencies?

				$ret = $validator->$property;
			}
		}
		return isset($ret) ? $ret : null;
	}
	
	private function generateCallbackBindJSString() {
		if ( count($this->callbacks) > 0 ) {
			$output = '';
			foreach ( $this->callbacks as $callbackName => $fnCode ) {
				$output .= '.bind("' . self::$_callbackFnPrefix
					. $callbackName . '", ' . $fnCode . ')';
                     }
			return $output;
		}
		return '';
	}
}