tableau-mkt/elomentary

View on GitHub
src/Api/ReadableInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

/**
 * @file
 * Contains \Eloqua\Api\ReadableInterface
 */

namespace Eloqua\Api;

interface ReadableInterface {

  /**
   * Get extended information for a single record of this type.
   *
   * @param int $id
   *   The ID of the individual record to be returned.
   *
   * @param string $depth
   *   Transform depth to use when retrieving the record. One of:
   *   - reference
   *   - minimal
   *   - partial
   *   - complete
   *
   * @param string $extensions
   *   @todo Document this parameter.
   *
   * @return array
   *   An associative array representing the desired record.
   */
  public function show($id, $depth, $extensions);

}