cleanup

Author: h7io

code/DropdownImageField.php

@@ -1,81 +1,31 @@
 <?php
 
-class DropdownImageField extends FormField {
+class DropdownImageField extends DropdownField {
 
-	/**
-	 * @var boolean $source Associative or numeric array of all dropdown items,
-	 * with array key as the submitted field value, and the array value as a
-	 * natural language description shown in the interface element.
-	 */
-	protected $sourceObject;
-        
-	/**
-	 * @ignore
-	 */
 	protected $keyField, $labelField, $imageField;
-        
-	/**
-	 * @var boolean $isSelected Determines if the field was selected
-	 * at the time it was rendered, so if {@link $value} matches on of the array
-	 * values specified in {@link $source}
-	 */
-	protected $isSelected;
-	
-	/**
-	 * @var boolean $hasEmptyDefault Show the first <option> element as
-	 * empty (not having a value), with an optional label defined through
-	 * {@link $emptyString}. By default, the <select> element will be
-	 * rendered with the first option from {@link $source} selected.
-	 */
-	protected $hasEmptyDefault = false;
-	
-	/**
-	 * @var string $emptyString The title shown for an empty default selection,
-	 * e.g. "Select...".
-	 */
-	protected $emptyString = '';
-	
-	/**
-	 * @var array $disabledItems The keys for items that should be disabled (greyed out) in the dropdown
-	 */
-	protected $disabledItems = array();
 
-	public function __construct($name, $title=null, $sourceObject='Group', $keyField = 'ID', $labelField = null, $imageField = 'Image', $value='', $form=null, $emptyString=null) {
-		$this->setSourceObject($sourceObject);
+	public function __construct($name, $title, $sourceObject, $keyField = 'ID', $labelField = 'Title', $imageField = 'Image', $value='', $form=null) {
 
 		$this->keyField     = $keyField;
 		$this->labelField   = $labelField;
                 $this->imageField   = $imageField;
-
-		if($emptyString === true) {
-			Deprecation::notice('3.1',
-				'Please use setHasEmptyDefault(true) instead of passing a boolean true $emptyString argument',
-				Deprecation::SCOPE_GLOBAL);
-		}
-		if(is_string($emptyString)) {
-			Deprecation::notice('3.1', 'Please use setEmptyString() instead of passing a string emptyString argument.',
-				Deprecation::SCOPE_GLOBAL);
-		}
-
-		if($emptyString) $this->setHasEmptyDefault(true);
-		if(is_string($emptyString)) $this->setEmptyString($emptyString);
-
-		parent::__construct($name, ($title===null) ? $name : $title, $value, $form);
 
+		parent::__construct($name, ($title===null) ? $name : $title, $sourceObject, $value, $form);
+
                 $this->addExtraClass('dropdown');
 	}
 
 	public function Field($properties = array()) {
+            
                 $dirName = basename(dirname(dirname(__FILE__)));;
 
                 Requirements::javascript($dirName.'/javascript/Polyfill.js');
 		Requirements::javascript($dirName.'/javascript/ImageSelect.jquery.js');
                 Requirements::css($dirName.'/css/ImageSelect.css');
 
-		$source = $this->getSourceObject();
+		$source = $this->getSource();
 		$options = array();
 		if($source) {
-			// SQLMap needs this to add an empty value to the options
 			if(is_object($source) && $this->emptyString) {
 				$options[] = new ArrayData(array(
 					'Value' => '',
@@ -125,102 +75,19 @@ public function Field($properties = array()) {
 
 		$properties = array_merge($properties, array('Options' => new ArrayList($options)));
 
-		return parent::Field($properties);
-	}
-	
-	/**
-	 * Mark certain elements as disabled,
-	 * regardless of the {@link setDisabled()} settings.
-	 * 
-	 * @param array $items Collection of array keys, as defined in the $source array
-	 */
-	public function setDisabledItems($items){
-		$this->disabledItems = $items;
-		return $this;
+		return FormField::Field($properties);
 	}
 
-	/**
-	 * @return Array
-	 */
-	public function getDisabledItems(){
-		return $this->disabledItems;
-	}
-
-	public function getAttributes() {
-		return array_merge(
-			parent::getAttributes(),
-			array('type' => null, 'value' => null)
-		);
-	}
-
-	/**
-	 * @return boolean
-	 */
-	public function isSelected() {
-		return $this->isSelected;
-	}
-
 	/**
 	 * Gets the source array including any empty default values.
 	 * 
 	 * @return array
 	 */
 	public function getSourceObject() {
-		if(is_array($this->sourceObject) && $this->getHasEmptyDefault()) {
-                        return ArrayList::create()->unshift(array($this->keyField = '', $this->labelField = $this->emptyString, $this->imageField = ''));
+		if(is_object($this->source) && $this->getHasEmptyDefault()) {
+                        return $this->source->unshift(array($this->keyField = '', $this->labelField = $this->emptyString, $this->imageField = ''));
 		} else {
-			return $this->sourceObject;
+			return $this->source;
 		}
 	}
-
-	/**
-	 * @param array $source
-	 */
-	public function setSourceObject($source) {
-		$this->sourceObject = $source;
-		return $this;
-	}
-	
-	/**
-	 * @param boolean $bool
-	 */
-	public function setHasEmptyDefault($bool) {
-		$this->hasEmptyDefault = $bool;
-		return $this;
-	}
-	
-	/**
-	 * @return boolean
-	 */
-	public function getHasEmptyDefault() {
-		return $this->hasEmptyDefault;
-	}
-
-	/**
-	 * Set the default selection label, e.g. "select...".
-	 * Defaults to an empty string. Automatically sets
-	 * {@link $hasEmptyDefault} to true.
-	 *
-	 * @param string $str
-	 */
-	public function setEmptyString($str) {
-		$this->setHasEmptyDefault(true);
-		$this->emptyString = $str;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getEmptyString() {
-		return $this->emptyString;
-	}
-
-	public function performReadonlyTransformation() {
-		$field = $this->castedCopy('LookupField');
-		$field->setSourceObject($this->getSourceObject());
-		$field->setReadonly(true);
-		
-		return $field;
-	}
 }

javascript/ImageSelect.jquery.js

@@ -159,6 +159,8 @@
 
                         if(img_src != undefined){
                             var template = html_template.replace('{url}',img_src);
+                            // SS uses a modified Chosen.js and after the 'showing_dropdown' event the 
+                            // values get immediatelly reset, also removing the images. Solved it with setTimeout.
                             setTimeout(function(li, template){
                                 $(li).prepend(template.replace('{class_name}','chose-image-list'));
                             }, 1, li, template);

templates/DropdownImageField.ss

@@ -1,5 +1,11 @@
 <select $AttributesHTML>
 <% loop $Options %>
-	<option data-img-src="$Image.Link" value="$Value.XML"<% if $Selected %> selected="selected"<% end_if %><% if $Disabled %> disabled="disabled"<% end_if %>><% if Title == "--nbsp" %>&nbsp;<% else %>$Title.XML<% end_if %></option>
+	<option 
+            data-img-src="$Image.URL" 
+            value="$Value.XML"<% if $Selected %> 
+            selected="selected"<% end_if %><% if $Disabled %> 
+            disabled="disabled"<% end_if %>>
+            <% if $Title = "--nbsp" %>&nbsp;
+            <% else %>$Title.XML<% end_if %></option>
 <% end_loop %>
 </select>