views_plugin_display_services.inc in Services Views 7

Contains the page display plugin.

File

includes/views/views_plugin_display_services.inc

<?php

/**
 * @file
 * Contains the page display plugin.
 */

/**
 * The plugin that handles a Services callback.
 *
 * @ingroup views_display_plugins
 */
class views_plugin_display_services extends views_plugin_display {

  /**
   * {@inheritdoc}
   */
  public function has_path() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['path'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function execute() {
    if (!$this
      ->access()) {
      global $user;
      module_load_include('inc', 'services', 'includes/services.runtime');
      return services_error(t('Access denied for user @user', array(
        '@user' => isset($user->name) ? $user->name : 'anonymous',
      )), 401);
    }

    // Prior to this being called, the $view should already be set to this
    // display, and arguments should be set on the view.
    $this->view
      ->build();

    // Execute a view.
    $this->view
      ->execute();
    foreach ($this->view->field as $field) {
      $field
        ->pre_render($this->view->result);
    }

    // Render the fields.
    if (isset($this->view->style_plugin)) {
      $this->view->style_plugin
        ->render_fields($this->view->result);
    }

    // Map fields.
    $result = array();
    foreach ($this->view->result as $row_id => $item) {
      $new_item = new stdClass();
      foreach ($this->view->field as $field_name => $field) {

        // Skip this field?
        if (isset($field->options['exclude']) && $field->options['exclude'] == TRUE) {
          continue;
        }

        // Make sure new keys are alphanumerical, underscore and dash.
        $custom_key = !empty($field->options['label']) && preg_match('/^[0-9A-Za-z_-]*$/', $field->options['label']) ? $field->options['label'] : FALSE;
        if (isset($item->{$field->field_alias})) {
          $key = $custom_key ? $custom_key : $field->field_alias;
          $new_item->{$key} = $item->{$field->field_alias};
        }
        elseif (!empty($this->view->style_plugin->rendered_fields[$row_id][$field_name])) {
          $key = $custom_key ? $custom_key : $field_name;
          $new_item->{$key} = $this->view->style_plugin->rendered_fields[$row_id][$field_name];
        }
      }
      if (!empty($new_item)) {
        $result[] = $new_item;
      }
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return $this
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    module_load_include('resource.inc', 'services_views');
    return '<pre>' . json_encode(services_views_execute_view(NULL, $this->view, $this->display->id), JSON_PRETTY_PRINT) . '</pre>';
  }

  /**
   * Provide the summary for page options in the views UI.
   *
   * This output is returned as an array.
   */
  public function options_summary(&$categories, &$options) {

    // It is very important to call the parent function here:
    parent::options_summary($categories, $options);
    $categories['page'] = array(
      'title' => t('Services settings'),
      'column' => 'second',
      'build' => array(
        '#weight' => -10,
      ),
    );
    $path = strip_tags('/' . $this
      ->get_option('path'));
    if (empty($path)) {
      $path = t('None');
    }
    $options['path'] = array(
      'category' => 'page',
      'title' => t('Path'),
      'value' => views_ui_truncate($path, 24),
    );
  }

  /**
   * Provide the default form for setting options.
   */
  public function options_form(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_form($form, $form_state);
    switch ($form_state['section']) {
      case 'path':
        $form['#title'] .= t('Path of the Services resource');
        $form['#help_topic'] = 'path';
        $form['path'] = array(
          '#type' => 'textfield',
          '#description' => t('This is path element that comes after endpoint path.'),
          '#default_value' => $this
            ->get_option('path'),
        );
    }
  }

  /**
   * {@inheritdoc}
   */
  public function options_validate(&$form, &$form_state) {

    // It is very important to call the parent function here.
    parent::options_validate($form, $form_state);
    if ($form_state['section'] == 'path') {
      if (preg_match('/[^a-zA-Z0-9-_]+/', $form_state['values']['path'])) {
        form_error($form['path'], t('Use only alphanumeric characters, "-" and "_" for resource name'));
      }

      // Get current path and see if it was changed.
      $current_path = $this
        ->get_option('path');
      if ($current_path != $form_state['values']['path']) {

        // We build resources from database to bypass cache.
        module_load_include('inc', 'services', 'includes/services.resource_build');
        $resources = _services_build_resources();
        if (array_key_exists($form_state['values']['path'], $resources)) {
          form_error($form['path'], t('Resource with this path already exists.'));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function options_submit(&$form, &$form_state) {

    // It is very important to call the parent function here.
    parent::options_submit($form, $form_state);
    switch ($form_state['section']) {
      case 'path':
        $this
          ->set_option('path', $form_state['values']['path']);
        break;
    }
  }

}

Classes

Name	Description
views_plugin_display_services	The plugin that handles a Services callback.