protected function String::defineOptions

Same name in this branch
  1. 8.x drupal/core/modules/views/lib/Drupal/views/Plugin/views/argument/String.php \Drupal\views\Plugin\views\argument\String::defineOptions()
  2. 8.x drupal/core/modules/views/lib/Drupal/views/Plugin/views/filter/String.php \Drupal\views\Plugin\views\filter\String::defineOptions()

Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.

),

Return value

array Returns the options of this handler/plugin.

Overrides ArgumentPluginBase::defineOptions

1 call to String::defineOptions()
ListString::defineOptions in drupal/core/modules/field/lib/Drupal/field/Plugin/views/argument/ListString.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
1 method overrides String::defineOptions()
ListString::defineOptions in drupal/core/modules/field/lib/Drupal/field/Plugin/views/argument/ListString.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/argument/String.php, line 40
Definition of Drupal\views\Plugin\views\argument\String.

Class

String
Basic argument handler to implement string arguments that may have length limits.

Namespace

Drupal\views\Plugin\views\argument

Code

protected function defineOptions() {
  $options = parent::defineOptions();
  $options['glossary'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['limit'] = array(
    'default' => 0,
  );
  $options['case'] = array(
    'default' => 'none',
  );
  $options['path_case'] = array(
    'default' => 'none',
  );
  $options['transform_dash'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['break_phrase'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  if (!empty($this->definition['many to one'])) {
    $options['add_table'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['require_value'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
  }
  return $options;
}