Boolean.php in Zircon Profile 8
Same filename in this branch
Same filename and directory in other branches
Contains \Drupal\views\Plugin\views\field\Boolean.
Namespace
Drupal\views\Plugin\views\fieldFile
core/modules/views/src/Plugin/views/field/Boolean.phpView source
<?php
/**
* @file
* Contains \Drupal\views\Plugin\views\field\Boolean.
*/
namespace Drupal\views\Plugin\views\field;
use Drupal\Component\Utility\Xss as UtilityXss;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Render\ViewsRenderPipelineMarkup;
use Drupal\views\ResultRow;
use Drupal\views\ViewExecutable;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
/**
* A handler to provide proper displays for booleans.
*
* Allows for display of true/false, yes/no, on/off, enabled/disabled.
*
* Definition terms:
* - output formats: An array where the first entry is displayed on boolean true
* and the second is displayed on boolean false. An example for sticky is:
* @code
* 'output formats' => array(
* 'sticky' => array(t('Sticky'), ''),
* ),
* @endcode
*
* @ingroup views_field_handlers
*
* @ViewsField("boolean")
*/
class Boolean extends FieldPluginBase {
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['type'] = array(
'default' => 'yes-no',
);
$options['type_custom_true'] = array(
'default' => '',
);
$options['type_custom_false'] = array(
'default' => '',
);
$options['not'] = array(
'default' => FALSE,
);
return $options;
}
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
$default_formats = array(
'yes-no' => array(
t('Yes'),
$this
->t('No'),
),
'true-false' => array(
t('True'),
$this
->t('False'),
),
'on-off' => array(
t('On'),
$this
->t('Off'),
),
'enabled-disabled' => array(
t('Enabled'),
$this
->t('Disabled'),
),
'boolean' => array(
1,
0,
),
'unicode-yes-no' => array(
'✔',
'✖',
),
);
$output_formats = isset($this->definition['output formats']) ? $this->definition['output formats'] : array();
$custom_format = array(
'custom' => array(
t('Custom'),
),
);
$this->formats = array_merge($default_formats, $output_formats, $custom_format);
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
foreach ($this->formats as $key => $item) {
$options[$key] = implode('/', $item);
}
$form['type'] = array(
'#type' => 'select',
'#title' => $this
->t('Output format'),
'#options' => $options,
'#default_value' => $this->options['type'],
);
$form['type_custom_true'] = array(
'#type' => 'textfield',
'#title' => $this
->t('Custom output for TRUE'),
'#default_value' => $this->options['type_custom_true'],
'#states' => array(
'visible' => array(
'select[name="options[type]"]' => array(
'value' => 'custom',
),
),
),
);
$form['type_custom_false'] = array(
'#type' => 'textfield',
'#title' => $this
->t('Custom output for FALSE'),
'#default_value' => $this->options['type_custom_false'],
'#states' => array(
'visible' => array(
'select[name="options[type]"]' => array(
'value' => 'custom',
),
),
),
);
$form['not'] = array(
'#type' => 'checkbox',
'#title' => $this
->t('Reverse'),
'#description' => $this
->t('If checked, true will be displayed as false.'),
'#default_value' => $this->options['not'],
);
parent::buildOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function render(ResultRow $values) {
$value = $this
->getValue($values);
if (!empty($this->options['not'])) {
$value = !$value;
}
if ($this->options['type'] == 'custom') {
$custom_value = $value ? $this->options['type_custom_true'] : $this->options['type_custom_false'];
return ViewsRenderPipelineMarkup::create(UtilityXss::filterAdmin($custom_value));
}
elseif (isset($this->formats[$this->options['type']])) {
return $value ? $this->formats[$this->options['type']][0] : $this->formats[$this->options['type']][1];
}
else {
return $value ? $this->formats['yes-no'][0] : $this->formats['yes-no'][1];
}
}
}