class Boolean

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/field/Boolean.php \Drupal\views\Plugin\views\field\Boolean
  2. 8.9.x core/modules/views/src/Plugin/views/field/Boolean.php \Drupal\views\Plugin\views\field\Boolean
  3. 10 core/modules/views/src/Plugin/views/field/Boolean.php \Drupal\views\Plugin\views\field\Boolean

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:

     'output formats' => [
       'sticky' => [t('Sticky'), ''],
     ],
     

Hierarchy

Expanded class hierarchy of Boolean

Related topics

252 string references to 'Boolean'
BaseFieldOverrideResourceTestBase::getExpectedNormalizedEntity in core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideResourceTestBase.php
BaseFieldOverrideTest::getExpectedDocument in core/modules/jsonapi/tests/src/Functional/BaseFieldOverrideTest.php
Returns the expected JSON:API document for the entity.
BlockContent::getFilters in core/modules/block_content/src/Plugin/views/wizard/BlockContent.php
Gets the filters property.
BlockContentWizardTest::testViewAddBlockContent in core/modules/block_content/tests/src/Functional/Views/BlockContentWizardTest.php
Tests creating a 'block_content' entity view.
block_content.schema.yml in core/modules/block_content/config/schema/block_content.schema.yml
core/modules/block_content/config/schema/block_content.schema.yml

... See full list

File

core/modules/views/src/Plugin/views/field/Boolean.php, line 29

Namespace

Drupal\views\Plugin\views\field
View source
class Boolean extends FieldPluginBase {
    
    /**
     * The allowed formats.
     */
    public array $formats;
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['type'] = [
            'default' => 'yes-no',
        ];
        $options['type_custom_true'] = [
            'default' => '',
        ];
        $options['type_custom_false'] = [
            'default' => '',
        ];
        $options['not'] = [
            'default' => FALSE,
        ];
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function init(ViewExecutable $view, DisplayPluginBase $display, ?array &$options = NULL) {
        parent::init($view, $display, $options);
        $default_formats = [
            'yes-no' => [
                $this->t('Yes'),
                $this->t('No'),
            ],
            'true-false' => [
                $this->t('True'),
                $this->t('False'),
            ],
            'on-off' => [
                $this->t('On'),
                $this->t('Off'),
            ],
            'enabled-disabled' => [
                $this->t('Enabled'),
                $this->t('Disabled'),
            ],
            'boolean' => [
                1,
                0,
            ],
            'unicode-yes-no' => [
                '✔',
                '✖',
            ],
        ];
        $output_formats = $this->definition['output formats'] ?? [];
        $custom_format = [
            'custom' => [
                $this->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'] = [
            '#type' => 'select',
            '#title' => $this->t('Output format'),
            '#options' => $options,
            '#default_value' => $this->options['type'],
        ];
        $form['type_custom_true'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Custom output for TRUE'),
            '#default_value' => $this->options['type_custom_true'],
            '#states' => [
                'visible' => [
                    'select[name="options[type]"]' => [
                        'value' => 'custom',
                    ],
                ],
            ],
        ];
        $form['type_custom_false'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Custom output for FALSE'),
            '#default_value' => $this->options['type_custom_false'],
            '#states' => [
                'visible' => [
                    'select[name="options[type]"]' => [
                        'value' => 'custom',
                    ],
                ],
            ],
        ];
        $form['not'] = [
            '#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];
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Boolean::$formats public property The allowed formats.
Boolean::buildOptionsForm public function Overrides FieldPluginBase::buildOptionsForm
Boolean::defineOptions protected function Overrides FieldPluginBase::defineOptions
Boolean::init public function Overrides FieldPluginBase::init
Boolean::render public function Overrides FieldPluginBase::render
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
FieldPluginBase::$additional_fields public property
FieldPluginBase::$aliases public property
FieldPluginBase::$field_alias public property
FieldPluginBase::$lastRenderIndex protected property Keeps track of the last render index.
FieldPluginBase::$last_render public property
FieldPluginBase::$last_render_text public property
FieldPluginBase::$last_tokens public property
FieldPluginBase::$linkGenerator protected property The link generator.
FieldPluginBase::$original_value public property
FieldPluginBase::$renderer protected property Stores the render API renderer. Overrides PluginBase::$renderer 1
FieldPluginBase::addAdditionalFields protected function Add 'additional' fields to the query.
FieldPluginBase::addSelfTokens protected function Add any special tokens this field might use for itself. 4
FieldPluginBase::adminLabel public function Overrides HandlerBase::adminLabel
FieldPluginBase::adminSummary public function Provide extra data to the administration form. Overrides HandlerBase::adminSummary
FieldPluginBase::advancedRender public function Overrides FieldHandlerInterface::advancedRender
FieldPluginBase::allowAdvancedRender protected function Determine if this field can allow advanced rendering.
FieldPluginBase::clickSort public function Overrides FieldHandlerInterface::clickSort 1
FieldPluginBase::clickSortable public function Overrides FieldHandlerInterface::clickSortable 5
FieldPluginBase::documentSelfTokens protected function Document any special tokens this field might use for itself. 3
FieldPluginBase::elementClasses public function Overrides FieldHandlerInterface::elementClasses
FieldPluginBase::elementLabelClasses public function Overrides FieldHandlerInterface::elementLabelClasses
FieldPluginBase::elementLabelType public function Overrides FieldHandlerInterface::elementLabelType
FieldPluginBase::elementType public function Overrides FieldHandlerInterface::elementType 1
FieldPluginBase::elementWrapperClasses public function Overrides FieldHandlerInterface::elementWrapperClasses
FieldPluginBase::elementWrapperType public function Overrides FieldHandlerInterface::elementWrapperType
FieldPluginBase::getElements public function Overrides FieldHandlerInterface::getElements
FieldPluginBase::getEntity public function Overrides FieldHandlerInterface::getEntity
FieldPluginBase::getFieldTokenPlaceholder protected function Returns a token placeholder for the current field.
FieldPluginBase::getPreviousFieldLabels protected function Returns all field labels of fields before this field.
FieldPluginBase::getRenderer protected function Returns the render API renderer. Overrides PluginBase::getRenderer
FieldPluginBase::getRenderTokens public function Overrides FieldHandlerInterface::getRenderTokens
FieldPluginBase::getTokenValuesRecursive protected function Recursive function to add replacements for nested query string parameters.
FieldPluginBase::getValue public function Overrides FieldHandlerInterface::getValue 2
FieldPluginBase::isValueEmpty public function Overrides FieldHandlerInterface::isValueEmpty
FieldPluginBase::label public function Overrides FieldHandlerInterface::label
FieldPluginBase::linkGenerator protected function Gets the link generator.
FieldPluginBase::postRender public function Overrides FieldHandlerInterface::postRender
FieldPluginBase::preRender public function Overrides FieldHandlerInterface::preRender 10
FieldPluginBase::query public function Called to add the field to a query. Overrides HandlerBase::query 19
FieldPluginBase::renderAltered protected function Render this field as user-defined altered text.
FieldPluginBase::renderAsLink protected function Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::renderText public function Overrides FieldHandlerInterface::renderText
FieldPluginBase::renderTrimText protected function Trims the field down to the specified length.
FieldPluginBase::RENDER_TEXT_PHASE_COMPLETELY constant Indicator of the renderText() method for rendering the whole element.
FieldPluginBase::RENDER_TEXT_PHASE_EMPTY constant Indicator of the renderText() method for rendering the empty text.
FieldPluginBase::RENDER_TEXT_PHASE_SINGLE_ITEM constant Indicator of the renderText() method for rendering a single item.
FieldPluginBase::submitOptionsForm public function Performs some cleanup tasks on the options array before saving it. Overrides PluginBase::submitOptionsForm 1
FieldPluginBase::theme public function Overrides FieldHandlerInterface::theme
FieldPluginBase::themeFunctions public function Overrides PluginBase::themeFunctions
FieldPluginBase::tokenizeValue public function Overrides FieldHandlerInterface::tokenizeValue
FieldPluginBase::trimText public static function Trims the field down to the specified length.
FieldPluginBase::useStringGroupBy public function Overrides FieldHandlerInterface::useStringGroupBy
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$is_handler public property
HandlerBase::$moduleHandler protected property The module handler. 2
HandlerBase::$query public property Where the $query object will reside. 7
HandlerBase::$realField public property The real field.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Overrides ViewsHandlerInterface::access 5
HandlerBase::breakString public static function Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Overrides ViewsHandlerInterface::broken
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting. 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 2
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::calculateDependencies public function Overrides PluginBase::calculateDependencies 11
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function Determines if the handler has extra options. 2
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed'.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler. 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitTemporaryForm public function Submits a temporary form.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 13
HandlerBase::validate public function Overrides PluginBase::validate 2
HandlerBase::validateExposed public function Validate the exposed handler form. 5
HandlerBase::validateExposeForm public function Validate the options form. 2
HandlerBase::validateExtraOptionsForm public function Validate the options form. 1
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 43
PluginBase::$definition public property Plugins' definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$position public property The handler position.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::create public static function Overrides ContainerFactoryPluginInterface::create 61
PluginBase::destroy public function Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Overrides ViewsPluginInterface::getProvider
PluginBase::globalTokenForm public function Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::trustedCallbacks public static function Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validateOptionsForm public function Overrides ViewsPluginInterface::validateOptionsForm 15
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.