Allow rendeting public field with Field API formatter.

Author: amitaibu

.travis.yml

@@ -2,7 +2,6 @@ language: php
 
 php:
   - 5.3
-  - 5.5
 
 mysql:
   database: restful

plugins/restful/RestfulEntityBase.php

@@ -30,6 +30,9 @@ abstract class RestfulEntityBase extends \RestfulDataProviderEFQ implements \Res
    *   content. This can be used for example on a text field with filtered text
    *   input format where we would need to do $wrapper->body->value->value().
    *   Defaults to FALSE.
+   * - "formatter": Used for rendering the value of a configurable field using
+   *   Drupal field API's formatter. The value is the $display value that is
+   *   passed to field_view_field().
    * - "wrapper_method": The wrapper's method name to perform on the field.
    *   This can be used for example to get the entity label, by setting the
    *   value to "label". Defaults to "value".
@@ -302,49 +305,29 @@ public function viewEntity($entity_id) {
       else {
         // Exposing an entity field.
         $property = $info['property'];
-
         $sub_wrapper = $info['wrapper_method_on_entity'] ? $wrapper : $wrapper->{$property};
 
         // Check user has access to the property.
         if ($property && !$this->checkPropertyAccess('view', $public_field_name, $sub_wrapper, $wrapper)) {
           continue;
         }
 
-        $method = $info['wrapper_method'] ? $info['wrapper_method'] : NULL;
-        $resource = $info['resource'] ? $info['resource'] : NULL;
-
-        if ($sub_wrapper instanceof EntityListWrapper) {
-          // Multiple value.
-          foreach ($sub_wrapper as $item_wrapper) {
-            if ($info['sub_property'] && $item_wrapper->value()) {
-              $item_wrapper = $item_wrapper->{$info['sub_property']};
-            }
-
-            if ($resource) {
-              if ($value_from_resource = $this->getValueFromResource($item_wrapper, $property, $resource, $public_field_name, $wrapper->getIdentifier())) {
-                $value[] = $value_from_resource;
-              }
+        if (empty($info['formatter'])) {
+          if ($sub_wrapper instanceof EntityListWrapper) {
+            // Multiple values.
+            foreach ($sub_wrapper as $item_wrapper) {
+              $value[] = $this->getValueFromProperty($wrapper, $item_wrapper, $info, $public_field_name);
             }
-            else {
-              // Wrapper method.
-              $value[] = $item_wrapper->{$method}();
-            }
-          }
-        }
-        else {
-          // Single value.
-          if ($info['sub_property'] && $sub_wrapper->value()) {
-            $sub_wrapper = $sub_wrapper->{$info['sub_property']};
-          }
-
-          if ($resource) {
-            $value = $this->getValueFromResource($sub_wrapper, $property, $resource, $public_field_name, $wrapper->getIdentifier());
           }
           else {
-            // Wrapper method.
-            $value = $sub_wrapper->{$method}();
+            // Single value.
+            $value = $this->getValueFromProperty($wrapper, $sub_wrapper, $info, $public_field_name);
           }
         }
+        else {
+          // Get value from field formatter.
+          $value = $this->getValueFromFieldFormatter($wrapper, $sub_wrapper, $info);
+        }
       }
 
       if ($value && $info['process_callbacks']) {
@@ -363,6 +346,84 @@ public function viewEntity($entity_id) {
     return $values;
   }
 
+  /**
+   * Get value from a property.
+   *
+   * @param EntityMetadataWrapper $wrapper
+   *   The wrapped entity.
+   * @param EntityMetadataWrapper $sub_wrapper
+   *   The wrapped property.
+   * @param array $info
+   *   The public field info array.
+   * @param $public_field_name
+   *   The field name.
+   *
+   * @return mixed
+   *   A single or multiple values.
+   */
+  protected function getValueFromProperty(\EntityMetadataWrapper $wrapper, \EntityMetadataWrapper $sub_wrapper, array $info, $public_field_name) {
+    $property = $info['property'];
+    $method = $info['wrapper_method'];
+    $resource = $info['resource'] ?: NULL;
+
+    if ($info['sub_property'] && $sub_wrapper->value()) {
+      $sub_wrapper = $sub_wrapper->{$info['sub_property']};
+    }
+
+    if ($resource) {
+      $value = $this->getValueFromResource($sub_wrapper, $property, $resource, $public_field_name, $wrapper->getIdentifier());
+    }
+    else {
+      // Wrapper method.
+      $value = $sub_wrapper->{$method}();
+    }
+
+    return $value;
+  }
+
+  /**
+   * Get value from a field rendered by Drupal field API's formatter.
+   *
+   * @param EntityMetadataWrapper $wrapper
+   *   The wrapped entity.
+   * @param EntityMetadataWrapper $sub_wrapper
+   *   The wrapped property.
+   * @param array $info
+   *   The public field info array.
+   *
+   * @return mixed
+   *   A single or multiple values.
+   */
+  protected function getValueFromFieldFormatter(\EntityMetadataWrapper $wrapper, \EntityMetadataWrapper $sub_wrapper, array $info) {
+    $property = $info['property'];
+
+    if (!field_info_field($property)) {
+      // Property is not a field.
+      throw new \RestfulServerConfigurationException(format_string('@property is not a configurable field, so it cannot be processed using field API formatter', array('@property' => $property)));
+    }
+
+    // Get values from the formatter.
+    $output = field_view_field($this->getEntityType(), $wrapper->value(), $property, $info['formatter']);
+
+    // Unset the theme, as we just want to get the value from the formatter,
+    // without the wrapping HTML.
+    unset($output['#theme']);
+
+
+    if ($sub_wrapper instanceof EntityListWrapper) {
+      // Multiple values.
+      foreach (element_children($output) as $delta) {
+        $value[] = drupal_render($output[$delta]);
+      }
+    }
+    else {
+      // Single value.
+      $value = drupal_render($output);
+    }
+
+    return $value;
+  }
+
   /**
    * Get the "target_type" property from an field or property reference.
    *
@@ -1174,6 +1235,7 @@ public function getPublicFields() {
         'sub_property' => FALSE,
         'wrapper_method' => 'value',
         'wrapper_method_on_entity' => FALSE,
+        'formatter' => FALSE,
       );
 
       if ($field = field_info_field($info['property'])) {

restful.info

@@ -81,5 +81,6 @@ files[] = tests/RestfulUpdateEntityTestCase.test
 files[] = tests/RestfulSubResourcesCreateEntityTestCase.test
 files[] = tests/RestfulUpdateEntityCurlTestCase.test
 files[] = tests/RestfulUserLoginCookieTestCase.test
-files[] = tests/RestfulViewEntityTestCase.test
 files[] = tests/RestfulViewEntityMultiLingualTestCase.test
+files[] = tests/RestfulViewEntityTestCase.test
+files[] = tests/RestfulViewModeAndFormatterTestCase.test

tests/RestfulViewEntityTestCase.test

@@ -266,25 +266,6 @@ class RestfulViewEntityTestCase extends RestfulCurlBaseTestCase {
     $this->assertEqual(count(array_filter(array_values($result[0]['images'][0]['styles']))) == 3, 'The image styles are populated.');
   }
 
-  /**
-   * Test the view mode integration.
-   */
-  public function testViewModes() {
-    $handler = restful_get_restful_handler('articles', 1, 7);
-    $nodes[] = $this->createNodeWithTags();
-    $nodes[] = $this->createNodeWithTags();
-    // Make sure to get more than one node to increase coverage on
-    // \RestfulEntityViewMode.
-    $results = $handler->get($nodes[0]->nid . ',' . $nodes[1]->nid);
-
-    // Make sure that all the fields were mapped.
-    $this->assertNotNull($results[0]['body']);
-    $this->assertFalse(empty($results[0]['body']), 'Body is not empty.');
-    $this->assertNotNull($results[0]['tags']);
-    $this->assertFalse(empty($results[0]['tags']), 'Tags are not empty.');
-    $this->assertNotNull($results[0]['image']);
-  }
-
   /**
    * Test the generation of the Vary headers.
    */
@@ -343,7 +324,7 @@ class RestfulViewEntityTestCase extends RestfulCurlBaseTestCase {
    * Test the Simple JSON formatter.
    */
   public function testSimpleJson() {
-    $node = $this->createNodeWithTags();
+    $node = restful_test_create_node_with_tags();
     $handler = restful_get_restful_handler('articles', 1, 5);
     // Use the simple JSON formatter.
     $handler->setPluginKey('formatter', 'json');
@@ -369,7 +350,7 @@ class RestfulViewEntityTestCase extends RestfulCurlBaseTestCase {
 
     // Assert the HATEOAS.
     // Create another node for pagination.
-    $this->createNodeWithTags();
+    restful_test_create_node_with_tags();
     $handler->setRange(1);
     $response = $handler->get();
     $result = $formatter->format($response);
@@ -380,37 +361,4 @@ class RestfulViewEntityTestCase extends RestfulCurlBaseTestCase {
     $this->assertEqual(count($decoded_json['data']), 1, 'The correct number of items was listed.');
     $this->assertNotNull($decoded_json['next'], '"Next" property added.');
   }
-
-  /**
-   * Helper function that creates a node with taxonomy terms.
-   *
-   * @return object
-   *   The created node.
-   *
-   * @throws Exception
-   * @throws FieldException
-   */
-  protected function createNodeWithTags() {
-    $bundle = 'article';
-    // Create a node with some tags in it as embeds.
-    $node = $this->drupalCreateNode(array('type' => $bundle));
-
-    $vocabulary = taxonomy_vocabulary_machine_name_load('tags');
-
-    // Create a random number of tags for the created node.
-    for ($index = 0; $index < mt_rand(1, 10); $index++) {
-      $term = (object) array(
-        'vid' => $vocabulary->vid,
-        'name' => $this->randomString(),
-      );
-      taxonomy_term_save($term);
-      $terms[] = $term;
-      $node->field_tags[LANGUAGE_NONE][$index]['tid'] = $term->tid;
-    }
-    node_save($node);
-
-    return $node;
-
-  }
-
 }

tests/RestfulViewModeAndFormatterTestCase.test

@@ -0,0 +1,77 @@
+<?php
+
+/**
+ * @file
+ * Contains RestfulViewModeFormatterTestCase
+ */
+
+class RestfulViewModeAndFormatterTestCase extends DrupalWebTestCase {
+
+  public static function getInfo() {
+    return array(
+      'name' => 'View mode and formatter',
+      'description' => 'Test the integration with entity view mode and field API formatters.',
+      'group' => 'Restful',
+    );
+  }
+
+  function setUp() {
+    parent::setUp('restful_example', 'restful_test');
+  }
+
+  /**
+   * Test the view mode integration.
+   */
+  public function testViewModeIntegration() {
+    $handler = restful_get_restful_handler('articles', 1, 7);
+    $nodes[] = restful_test_create_node_with_tags();
+    $nodes[] = restful_test_create_node_with_tags();
+    // Make sure to get more than one node to increase coverage on
+    // \RestfulEntityViewMode.
+    $result = $handler->get($nodes[0]->nid . ',' . $nodes[1]->nid);
+
+    // Make sure that all the fields were mapped.
+    $this->assertNotNull($result[0]['body'], 'Body field is populated.');
+    $this->assertTrue($result[0]['tags'], 'Tags field is populated.');
+    $this->assertNotNull($result[0]['image'], 'Image field is not NULL.');
+  }
+
+  /**
+   * Test the field API formatter integration.
+   */
+  public function testFormatterIntegration() {
+    $handler = restful_get_restful_handler('articles', 1, 5);
+
+    // Create node.
+    $text = 'Some body with long text';
+    $settings = array(
+      'type' => 'article',
+      'body' => array(
+        LANGUAGE_NONE => array(
+          array('value' => $text),
+        )
+      ),
+    );
+    $node = $this->drupalCreateNode($settings);
+
+    // Field with no formatter.
+    $result = $handler->get($node->nid);
+    $this->assertEqual(trim(strip_tags($result[0]['body'])), $text, 'Raw value passed without a formatter.');
+
+    // Add formatter settings.
+    $public_fields = $handler->getPublicFields();
+    $display = array(
+      'type' => 'text_summary_or_trimmed',
+      'settings' => array(
+        'trim_length' => 10,
+      ),
+    );
+    $public_fields['body']['formatter'] = $display;
+    $handler->setPublicFields($public_fields);
+
+    $result = $handler->get($node->nid);
+    // Core's trim formatter also inclues the opening <p> tag in the calculation
+    // of number of chars.
+    $this->assertEqual($result[0]['body'], '<p>Some bo</p>', 'Value trimmed by formatter.');
+  }
+}

tests/modules/restful_test/restful_test.module

@@ -390,6 +390,33 @@ function restful_test_create_vocabulary_and_terms($machine_name = 'test_vocab',
   return $vid;
 }
 
+/**
+ * Helper function; Create a node with taxonomy terms.
+ *
+ * @return object
+ *   The saved node.
+ */
+function restful_test_create_node_with_tags() {
+  $values = array('type' => 'article');
+  $node = entity_create('node', $values);
+
+  $vocabulary = taxonomy_vocabulary_machine_name_load('tags');
+
+  // Create a random number of tags for the created node.
+  for ($index = 0; $index < mt_rand(1, 10); $index++) {
+    $term = (object) array(
+      'vid' => $vocabulary->vid,
+      'name' => 'term ' . $vocabulary->vid . '::' . $index,
+    );
+    taxonomy_term_save($term);
+    $terms[] = $term;
+    $node->field_tags[LANGUAGE_NONE][$index]['tid'] = $term->tid;
+  }
+  node_save($node);
+
+  return $node;
+}
+
 /**
  * Instead of implementing hook_schema use this helper function.
  *