You are here

Home » API reference » Views Matrix 7 » views_matrix_plugin_style_matrix.inc » views_matrix_plugin_style_matrix

public function views_matrix_plugin_style_matrix::option_definition in Views Matrix 7

Same name and namespace in other branches
  1. 8 includes/views_matrix_plugin_style_matrix.inc \views_matrix_plugin_style_matrix::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_plugin_style::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

includes/views_matrix_plugin_style_matrix.inc, line 43
Class definition for views matrix plugin.

Class

views_matrix_plugin_style_matrix
@class Views Plugin Class

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['sticky'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['xconfig'] = array(
    'contains' => array(
      'field' => array(
        'default' => '',
      ),
      'sort_field' => array(
        'default' => '',
      ),
      'sort' => array(
        'default' => '',
      ),
      'first_column' => array(
        'default' => '',
      ),
      'class' => array(
        'default' => '',
      ),
    ),
  );
  $options['yconfig'] = array(
    'contains' => array(
      'field' => array(
        'default' => '',
      ),
      'row_numbers' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'row_number_format' => array(
        'default' => '[counter]) [label]',
      ),
      'sort_field' => array(
        'default' => '',
      ),
      'sort' => array(
        'default' => '',
      ),
      'class' => array(
        'default' => '',
      ),
    ),
  );
  $options['sortable_headers'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['header_init_sort'] = array(
    'default' => 'asc',
  );
  $options['hide_empty_columns'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['hide_empty_rows'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['one_result_per_cell'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['field_positions'] = array(
    'default' => array(),
  );
  return $options;
}