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

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