You are here

protected function RelationshipPluginBase::defineOptions in Views (for Drupal 7) 8.3

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 HandlerBase::defineOptions

4 calls to RelationshipPluginBase::defineOptions()
GroupwiseMax::defineOptions in lib/Drupal/views/Plugin/views/relationship/GroupwiseMax.php
Defines default values for options.
NodeTermData::defineOptions in lib/Views/taxonomy/Plugin/views/relationship/NodeTermData.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
RelationshipPluginBase::init in lib/Drupal/views/Plugin/views/relationship/RelationshipPluginBase.php
Init handler to let relationships live on tables other than the table they operate on.
Translation::defineOptions in lib/Views/translation/Plugin/views/relationship/Translation.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
4 methods override RelationshipPluginBase::defineOptions()
Broken::defineOptions in lib/Drupal/views/Plugin/views/relationship/Broken.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
GroupwiseMax::defineOptions in lib/Drupal/views/Plugin/views/relationship/GroupwiseMax.php
Defines default values for options.
NodeTermData::defineOptions in lib/Views/taxonomy/Plugin/views/relationship/NodeTermData.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
Translation::defineOptions in lib/Views/translation/Plugin/views/relationship/Translation.php
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

File

lib/Drupal/views/Plugin/views/relationship/RelationshipPluginBase.php, line 74
Definition of Drupal\views\Plugin\views\relationship\RelationshipPluginBase.

Class

RelationshipPluginBase
Simple relationship handler that allows a new version of the primary table to be linked in.

Namespace

Drupal\views\Plugin\views\relationship

Code

protected function defineOptions() {
  $options = parent::defineOptions();

  // Relationships definitions should define a default label, but if they aren't get another default value.
  if (!empty($this->definition['label'])) {
    $label = $this->definition['label'];
  }
  else {
    $label = !empty($this->definition['field']) ? $this->definition['field'] : $this->definition['base field'];
  }
  $options['label'] = array(
    'default' => $label,
    'translatable' => TRUE,
  );
  $options['required'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  return $options;
}