Drop down list with enum values for column of type ENUM >+> incorporate into giix

You are viewing revision #1 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.

next (#2) »

  1. The enumDropDownList
  2. Adding it to giix' CrudCode

Let's say our table 'mug' has a column named 'color' of the type ENUM('red','green','blue').
We want to replace the textfield for the attribute color in the create and update forms of a 'mug' with a drop down list, which has the enum values as options.
The main code was contributed by zaccaria in the forum (see this post).

I merely repeat that useful peace of code here, so it is available in the wikis, and describe how you can incorporate it into giix, so the drop down list is added automatically during code generation.

The enumDropDownList

Create the file ..\components\ZHtml.php with the following code:

class ZHtml extends CHtml
{	
	/**
	 * This code was contributed by zaccaria in the forum:
	 * http://www.yiiframework.com/forum/index.php?/topic/10079-enum-db-type-in-yii/ 
	 * This method generates a drop down list for columns of type ENUM.
	 * @param CModel $model The data model.
	 * @param string $attribute The attribute.
	 * @param array $htmlOptions Addtional HTML options.
	 * @return string The generated drop down list with the enum values for the attribute.
	 */
	public static function enumDropDownList($model, $attribute, $htmlOptions=array())
	{
	  return CHtml::activeDropDownList( $model, $attribute, self::enumItem($model,  $attribute), $htmlOptions);
	}
	
	public static function enumItem($model,$attribute) {
		$attr=$attribute;
		self::resolveName($model,$attr);
		preg_match('/\((.*)\)/',$model->tableSchema->columns[$attr]->dbType,$matches);
		foreach(explode(',', $matches[1]) as $value) {
				$value=str_replace("'",null,$value);
				$values[$value]=Yii::t('enumItem',$value);
		}
		return $values;
	} 
}

Then use it in the view files with:

<?php echo ZHtml::enumDropDownList( $model,'color' ); ?>

Adding it to giix' CrudCode

If you use giix for code generation, you can put the code above into the file ..\extensions\giix-components\GxHtml.php (only the function definitions, not the 'class' part).

Then add the following code into the file ..\extensions\giix-components\GxActiveForm.php:

public function enumDropDownList($model, $attribute, $htmlOptions = array()){
		return GxHtml::enumDropDownList($model, $attribute, $htmlOptions);
	}

Now you can use it in your view files with:

<?php echo $form->enumDropDownList($model, 'color')); ?>

To edit giix so it adds this line into the view files during code generation: in the file ..\extensions\giix-core\giixCrud\GiixCrudCode.php find the function generateActiveField. Add the condition for the enum type (enclosed between /*NEW_BEGIN* and /*NEW_END*/) into the code, so it looks like:

...
if (strtoupper($column->dbType) == 'TINYINT(1)'
		|| strtoupper($column->dbType) == 'BIT'
		|| strtoupper($column->dbType) == 'BOOL'
		|| strtoupper($column->dbType) == 'BOOLEAN') {
	return "echo \$form->checkBox(\$model, '{$column->name}')";
} /*NEW-BEGIN*/
else if (stripos($column->dbType, 'enum') !== false) {
	return "echo \$form->enumDropDownList(\$model, '{$column->name}')";
} /*NEW_END*/
else if (strtoupper($column->dbType) == 'DATE') {
...

That's it. If something is unclear/wrong/incomplete or you have other suggestions please let me know.

10 0
11 followers
Viewed: 39 053 times
Version: Unknown (update)
Category: How-tos
Written by: c@cba
Last updated by: nsanden
Created on: Feb 12, 2012
Last updated: 4 years ago
Update Article

Revisions

View all history

Related Articles