Adjust assertFormatterRdfa() parameters to allow for more advanced testing

Updated: Comment #N

Problem/Motivation

#2139551: Support RDFa output in date formatter and #2188877: Support RDFa output in telephone field formatter have identified use cases that where not thought of when first creating assertFormatterRdfa(). When testing field formatters output, we need more than just the field formatter machine name to set up the right field formatter (e.g. we sometimes need the formatter settings like in the case of the telephone test). Additionally, we not only need the expected value and the expected value type (literal or uri), but we also need the datatype in the case of date.

Current signature:

  /**
   * Helper function to test the formatter's RDFa.
   *
   * @param string $formatter
   *   The machine name of the formatter to test.
   * @param string $property
   *   The property that should be found.
   * @param string $value
   *   The expected value of the property.
   * @param string $object_type
   *   The object's type, either 'uri' or 'literal'.
   */
  protected function assertFormatterRdfa($formatter, $property, $value, $object_type = 'literal') {

Proposed resolution

  /**
   * Helper function to test the formatter's RDFa.
   *
   * @param array $formatter
   *   An associative array describing the formatter to test and its settings containing:
   *   - type: The machine name of the field formatter to test.
   *   - settings: The settings of the field formatter to test.
   * @param string $property
   *   The property that should be found.
   * @param array $expected_rdf_value
   *   An associative array describing the expected value of the property containing:
   *   - value: The actual value of the string or URI.
   *   - type: The type of RDF value, e.g. 'literal' for a string, or 'uri. Defaults to 'literal'.
   *   - datatype: (optional) The datatype of the value (e.g. xsd:dateTime). 
   */
  protected function assertFormatterRdfa($formatter, $property, $expected_rdf_value) {

$formatter becomes an array. $value is renamed to $expected_rdf_value, and $object_type disappears because it's folded into $expected_rdf_value.

For example, the following line:

    $this->assertFormatterRdfa('text_plain', 'http://schema.org/telephone', $this->testValue);

would become:

    $this->assertFormatterRdfa(array('type' => 'text_plain'), 'http://schema.org/telephone', array('value' => $this->testValue));

or another equivalent of writing it is:

    $formatter = array('type' => 'text_plain');
    $expected_rdf_value = array('value' => $this->testValue);
    $this->assertFormatterRdfa($formatter, 'http://schema.org/telephone', $expected_rdf_value);

Remaining tasks

write a patch

User interface changes

none

API changes

I don't think that self-contained test helper methods are consider as API changes, given that only the RDF module is using it, and it's very specific to RDFa parsing.