function views_handler_relationship::option_definition
3.x views_handler_relationship.inc | views_handler_relationship::option_definition() |
2.x views_handler_relationship.inc | 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::option_definition
See also
views_object::export_option_always()
views_object::unpack_translatable()
3 calls to views_handler_relationship::option_definition()
- views_handler_relationship_groupwise_max::option_definition in handlers/
views_handler_relationship_groupwise_max.inc - Defines default values for options.
- views_handler_relationship_node_term_data::option_definition in modules/
taxonomy/ views_handler_relationship_node_term_data.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_relationship_translation::option_definition in modules/
translation/ views_handler_relationship_translation.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
3 methods override views_handler_relationship::option_definition()
- views_handler_relationship_groupwise_max::option_definition in handlers/
views_handler_relationship_groupwise_max.inc - Defines default values for options.
- views_handler_relationship_node_term_data::option_definition in modules/
taxonomy/ views_handler_relationship_node_term_data.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_relationship_translation::option_definition in modules/
translation/ views_handler_relationship_translation.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
File
- handlers/
views_handler_relationship.inc, line 65 - Views' relationship handlers.
Class
- views_handler_relationship
- Simple relationship handler that allows a new version of the primary table to be linked in.
Code
function option_definition() {
$options = parent::option_definition();
// 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;
}