associated_display.inc 756 Bytes
Newer Older
Cody Craven's avatar
Cody Craven committed
1
<?php
2
// $Id$
Cody Craven's avatar
Cody Craven committed
3

4
5
/**
 * @todo Write class explanation
Cody Craven's avatar
Cody Craven committed
6
 */
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
abstract class TaxonomyDisplayAssociatedDisplayHandler extends TaxonomyDisplayHandlerForm {
  /**
   * Render the output to be displayed when the user views the taxonomy term.
   *
   * @param termObject $term
   *   The taxonomy term to be displayed.
   * @param mixed $options
   *   The data that was stored on behalf of the handler resulting from the
   *   return of the TaxonomyDisplayHandlerForm::formSubmit implementation.
   *
   * @return array
   *   The build the user will see for the associated content viewing the term.
   *
   * @see TaxonomyDisplayHandlerForm::formSubmit()
   * @see taxonomy_term_page()
   */
  abstract public function displayAssociated($term, $options = NULL);
}