class views_plugin_style_json in Views Datasource 6

Implementation of views_plugin_style

Hierarchy

• class \views_plugin_style_json extends \views_plugin_style

1 string reference to 'views_plugin_style_json'

views_json_views_plugins in ./views_json.views.inc

Implementation of hook_views_plugin().

File

./views_plugin_style_json.inc, line 12

Implementation of views_plugin_style for views_json

class views_plugin_style_json extends views_plugin_style {

  /**
   * Implementation of views_plugin_style::option_definition
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['root_object'] = array(
      'default' => 'nodes',
      'translatable' => FALSE,
    );
    $options['top_child_object'] = array(
      'default' => 'node',
      'translatable' => FALSE,
    );
    $options['field_output'] = array(
      'default' => 'normal',
      'translatable' => FALSE,
    );
    $options['plaintext_output'] = array(
      'default' => TRUE,
      'translatable' => FALSE,
    );
    $options['format'] = array(
      'default' => 'simple',
      'translatable' => FALSE,
    );
    $options['jsonp_prefix'] = array(
      'default' => NULL,
      'translatable' => FALSE,
    );
    $options['content_type'] = array(
      'default' => 'default',
      'translatable' => FALSE,
    );
    $options['using_views_api_mode'] = array(
      'default' => FALSE,
      'translatable' => FALSE,
    );
    return $options;
  }

  /**
   * Provide a form for setting options.
   *
   * @param $form
   * @param $form_state
   */
  function options_form(&$form, &$form_state) {
    $form['root_object'] = array(
      '#type' => 'textfield',
      '#title' => 'Root object name',
      '#default_value' => $this->options['root_object'],
      '#description' => 'The name of the root object in the JSON document. e.g nodes or users or forum_posts',
    );
    $form['top_child_object'] = array(
      '#type' => 'textfield',
      '#title' => 'Top-level child object',
      '#default_value' => $this->options['top_child_object'],
      '#description' => 'The name of each top-level child object in the JSON document. e.g node or user or forum_post',
    );
    $form['field_output'] = array(
      '#type' => 'radios',
      '#title' => 'Field output',
      '#description' => 'For each row in the view, fields can be output as either the field rendered by Views, or by the raw content of the field.',
      '#options' => array(
        'normal' => 'Normal',
        'raw' => 'Raw',
      ),
      '#default_value' => $this->options['field_output'],
    );
    $form['plaintext_output'] = array(
      '#type' => 'checkbox',
      '#title' => 'Plaintext output',
      '#default_value' => $this->options['plaintext_output'],
      '#description' => 'For each row in the view, strip all markup from the field output.',
    );
    $form['format'] = array(
      '#type' => 'radios',
      '#title' => 'JSON data format',
      '#options' => array(
        'simple' => 'Simple',
        'exhibit' => 'MIT Simile/Exhibit',
      ),
      '#default_value' => $this->options['format'],
      '#description' => 'What object format will be used for JSON output.',
    );
    $form['jsonp_prefix'] = array(
      '#type' => 'textfield',
      '#title' => 'JSONP prefix',
      '#default_value' => $this->options['jsonp_prefix'],
      '#description' => 'If used the JSON output will be enclosed with parentheses and prefixed by this label, as in the JSONP format.',
    );
    $form['content_type'] = array(
      '#type' => 'radios',
      '#title' => 'Content-Type',
      '#options' => array(
        'default' => "Default: application/json",
        'text/json' => 'text/json',
        'application/javascript' => t('application/javascript'),
      ),
      '#default_value' => $this->options['content_type'],
      '#description' => 'The Content-Type header that will be sent with the JSON output.',
    );
    $form['using_views_api_mode'] = array(
      '#type' => 'checkbox',
      '#title' => 'Views API mode',
      '#default_value' => $this->options['using_views_api_mode'],
      '#description' => t('With Views API mode the JSON will embedded as normal content so normal page processing is used. Leave it unchecked when JSON should be printed directly to the client.'),
    );
  }

  /**
   * Implementation of view_style_plugin::theme_functions(). Returns an array of theme functions to use
   * for the current style plugin
   * @return array
   */
  function theme_functions() {
    $options = $this->options;
    if ($options['format'] == 'simple') {
      $hook = 'views_views_json_style_simple';
    }
    if ($options['format'] == 'exhibit') {
      $hook = 'views_views_json_style_exhibit';
    }
    return views_theme_functions($hook, $this->view, $this->display);
  }

  /**
   * Implementation of views_style_plugin::additional_theme_functions(). Returns empty array.
   * @return array
   */
  function additional_theme_functions() {
    return array();
  }

  /**
   * Implementation of view_style_plugin::render()
   */
  function render() {
    $view = $this->view;
    $options = $this->options;
    $field = $view->field;
    $rows = array();
    foreach ($view->result as $row) {
      $rows[] = _views_json_render_fields($view, $row);
    }
    return theme($this
      ->theme_functions(), $this->view, $this->options, $rows);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_plugin_style_json::additional_theme_functions		function	Implementation of views_style_plugin::additional_theme_functions(). Returns empty array.
views_plugin_style_json::options_form		function	Provide a form for setting options.
views_plugin_style_json::option_definition		function	Implementation of views_plugin_style::option_definition
views_plugin_style_json::render		function	Implementation of view_style_plugin::render()
views_plugin_style_json::theme_functions		function	Implementation of view_style_plugin::theme_functions(). Returns an array of theme functions to use for the current style plugin