Skip to content

Commit

Permalink
Cherrypick from 2.1 SettingsWidget
Browse files Browse the repository at this point in the history
  • Loading branch information
@SamMousa @mennodekker
SamMousa authored and mennodekker committed Jul 30, 2013
1 parent af8fbeb commit 8e16ebb
Show file tree
Hide file tree
Showing 8 changed files with 464 additions and 29 deletions.
325 changes: 325 additions & 0 deletions application/extensions/SettingsWidget/SettingsWidget.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
<?php

class SettingsWidget extends CWidget
{
protected static $counter = 0;

public $action;
/**
*
* @var array Buttons for the form.
*/
public $buttons = array();
public $formHtmlOptions = array();
public $method = 'post';
public $settings = array();



public function beginForm()
{
echo CHtml::beginForm($this->action, $this->method, $this->formHtmlOptions);
}

public function endForm()
{
echo CHtml::endForm();
}
public function init() {
parent::init();

// Register assets.
Yii::app()->getClientScript()->registerPackage('jquery');
Yii::app()->getClientScript()->registerCssFile(App()->getAssetManager()->publish(dirname(__FILE__) . '/assets/settingswidget.css'));
Yii::app()->getClientScript()->registerScriptFile(App()->getAssetManager()->publish(dirname(__FILE__) . '/assets/settingswidget.js'));

// Add default form class.
$this->formHtmlOptions['class'] = isset($this->formHtmlOptions['class']) ? $this->formHtmlOptions['class'] . " settingswidget" : 'settingswidget';


// Start form
$this->beginForm();

}

protected function renderButton($label, $htmlOptions)
{
if (is_string($htmlOptions))
{
$label = $htmlOptions;
$htmlOptions = array();
}
echo CHtml::submitButton($label, $htmlOptions);
}

protected function renderButtons()
{
foreach ($this->buttons as $label => $htmlOptions)
{
$this->renderButton($label, $htmlOptions);
}
}

protected function renderSetting($name, $metaData, $form = null, $return = false)
{
$defaults = array(
'class' => array(),
'type' => 'string',
'labelOptions' => array(
'class' => 'control-label'
)
);
$metaData = array_merge($defaults, $metaData);

if (is_string($metaData['class']))
{
$metaData['class'] = array($metaData['class']);
}
if (isset($metaData['type']))
{
$function = "render{$metaData['type']}";

// Handle localization.
if (isset($metaData['localized']) && $metaData['localized'] == true)
{
$name = "{$name}[{$metaData['language']}]";
if (isset($metaData['current']) && is_array($metaData['current']) && isset($metaData['current'][$metaData['language']]))
{
$metaData['current'] = $metaData['current'][$metaData['language']];
}
else
{
unset($metaData['current']);
}
}


$result = $this->$function($name, $metaData, $form);

if ($return)
{
return $result;
}
else
{
echo $result;
}
}
}

protected function renderSettings()
{
//echo '<pre>'; var_dump($this->settings); echo ('</pre>'); return;
foreach($this->settings as $name => $metaData)
{
$this->renderSetting($name, $metaData);
}
}



public function run() {
parent::run();

// Render settings
$this->renderSettings();
// Render buttons
$this->renderButtons();
// End form
$this->endForm();
}




/***********************************************************************
* Settings renderers.
**********************************************************************/



public function renderBoolean($name, array $metaData, $form = null)
{
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : '';
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id);
}
$out .= CHtml::radioButtonList($id, $value, array(
0 => 'False',
1 => 'True'
), array('id' => $id, 'form' => $form, 'container'=>'div', 'separator' => ''));


return $out;
}

public function renderFloat($name, array $metaData, $form = null)
{
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : '';
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$out .= CHtml::textField($id, $value, array(
'id' => $id,
'form' => $form,
'pattern' => '\d+(\.\d+)?'
));

return $out;
}

public function renderHtml($name, array $metaData, $form = null)
{
// Register CKEditor library for inclusion.
App()->getClientScript()->registerCoreScript('ckeditor');
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : '';
$metaData['class'][] = 'htmleditor';
$readOnly = isset($metaData['readOnly']) ? $metaData['readOnly'] : false;
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$out .= Chtml::tag('div', array('class' => implode(' ', $metaData['class'])), CHtml::textArea($id, $value, array('id' => $id, 'form' => $form, 'readonly' => $readOnly)));
return $out;
}

public function renderInt($name, array $metaData, $form = null)
{
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : '';
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$out .= CHtml::textField($id, $value, array(
'id' => $id,
'form' => $form,
'data-type' => 'int',
'pattern' => '\d+'
));

return $out;
}

public function renderLogo($name, array $metaData)
{
return CHtml::image($metaData['path']);
}
public function renderRelevance($name, array $metaData, $form = null)
{
$out = '';
$metaData['class'][] = 'relevance';
$id = $name;


if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$value = isset($metaData['current']) ? $metaData['current'] : '';

$out .= CHtml::textArea($name, $value, array('id' => $id, 'form' => $form, 'class' => implode(' ', $metaData['class'])));

return $out;
}

public function renderSelect($name, array $metaData, $form = null)
{
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : (isset($metaData['default']) ? $metaData['default'] : null);
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$out .= CHtml::dropDownList($name, $value, $metaData['options'], array('form' => $form));

return $out;
}

public function renderString($name, array $metaData, $form = null)
{
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : '';
$readOnly = isset($metaData['readOnly']) ? $metaData['readOnly'] : false;
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$out .= CHtml::textField($id, $value, array('id' => $id, 'form' => $form, 'class' => implode(' ', $metaData['class']), 'readonly' => $readOnly));

return $out;
}

public function renderPassword($name, array $metaData, $form = null)
{
$out = '';
$id = $name;
$value = isset($metaData['current']) ? $metaData['current'] : '';
if (isset($metaData['label']))
{
$out .= CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
$out .= CHtml::passwordField($id, $value, array('id' => $id, 'form' => $form));

return $out;
}

public function renderList($name, array $metaData, $form = null)
{

if (isset($metaData['label']))
{
$label = CHtml::label($metaData['label'], $id, $metaData['labelOptions']);
}
else
{
$label = '';
}

$headers = '';
$cells = '';
foreach ($metaData['items'] as $itemName => $itemMetaData)
{
$headers .= CHtml::tag('th', array(), $itemMetaData['label']);
unset($itemMetaData['label']);
$cells .= CHtml::tag('td', array(), $this->renderSetting($itemName . '[]', $itemMetaData, $form, true));
}
$headers .= CHtml::tag('th');
$cells .= CHtml::tag('td', array(), $this->widget('bootstrap.widgets.TbButtonGroup', array(
'type' => 'link',
'buttons' => array(
array('icon' => 'icon-minus', 'htmlOptions' => array('class' => 'remove')),
array('icon' => 'icon-plus', 'htmlOptions' => array('class' => 'add')),
)

), true));
echo CHtml::openTag('div', array('class' => 'settingslist'));
echo CHtml::openTag('table');
// Create header row.
echo CHtml::openTag('thead');
echo $headers;
echo CHtml::closeTag('thead');

// Create cells.
echo CHtml::openTag('tbody');
echo CHtml::openTag('tr');
echo $cells;
echo CHtml::closeTag('tr');
echo CHtml::closeTag('tbody');
echo CHtml::closeTag('table');
echo CHtml::closeTag('div');
}
}

?>
19 changes: 19 additions & 0 deletions application/extensions/SettingsWidget/assets/settingswidget.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
div.row {
border: 2px solid red;
}

/*
Special layout for list settings (inline).
*/

form.settingswidget .settingslist input[data-type=int]{
width: 50px;
}

form.settingswidget .settingslist table{
width: 100%;
}
form.settingswidget .settingslist label{
width: auto;
margin-right: 5px;
}
42 changes: 42 additions & 0 deletions application/extensions/SettingsWidget/assets/settingswidget.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
$(document).ready(function() {
var removeRow = function ()
{
// Don't remove last row.
if ($(this).closest('tbody').children().length > 1)
{
$(this).closest('tr').fadeOut(400, function() { $(this).remove(); });
}

};

var addRow = function()
{
var baseRow = $(this).closest('tr');
// Create new row, hidden and with empty inputs.
var newRow = baseRow.clone(true);
newRow.find('input').each(function() { $(this).val(''); });

// Check if the first element contains a number value and, if so, increase it by one.
var parts = baseRow.find('input:first').val().match(/([\d]+|[^\d]+)/g);
for (var i = parts.length - 1; i > 0; --i)
{
var num = parseInt(parts[i]);
var length = parts[i].length;
if (num === num)
{
parts[i] = (num + 1).toString();
while (parts[i].length < length)
{
parts[i] = '0' + parts[i];
}
}
}
newRow.find('input:first').val(parts.join(''));
baseRow.after(newRow);
newRow.fadeIn();

}
$('form.settingswidget .settingslist a.remove').bind('click', removeRow);
$('form.settingswidget .settingslist a.add').bind('click', addRow);

})
Loading

0 comments on commit 8e16ebb

Please sign in to comment.