You are here

Home » API reference » Voting API 7.3 » votingapi_views_handler_relationship.inc » votingapi_views_handler_relationship

function votingapi_views_handler_relationship::option_definition in Voting API 7.3

Same name and namespace in other branches
  1. 6.2 views/votingapi_views_handler_relationship.inc \votingapi_views_handler_relationship::option_definition()
  2. 7.2 views/votingapi_views_handler_relationship.inc \votingapi_views_handler_relationship::option_definition()

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.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_handler_relationship::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/votingapi_views_handler_relationship.inc, line 28
Provide views handler for votingapi joins.

Class

votingapi_views_handler_relationship
A custom join handler that connects arbitrary base tables to VotingAPI's data.

Code

function option_definition() {
  $options = parent::option_definition();
  $label = !empty($this->definition['label']) ? $this->definition['label'] : $this->definition['title'];
  $options['label'] = array(
    'default' => $label,
    'translatable' => TRUE,
  );
  $options['votingapi']['value_type'] = array(
    'default' => NULL,
  );
  $options['votingapi']['tag'] = array(
    'default' => NULL,
  );
  if ($this->definition['base'] == 'votingapi_cache') {
    $options['votingapi']['function'] = array(
      'default' => NULL,
    );
  }
  elseif ($this->definition['base'] == 'votingapi_vote') {
    $options['current_user'] = array(
      'default' => FALSE,
    );
  }
  return $options;
}