term_display.inc 742 Bytes
Newer Older
Cody Craven's avatar
Cody Craven committed
1
2
3
<?php

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