You are here

abstract class TaxonomyDisplayAssociatedDisplayHandler in Taxonomy display 7

Abstract class for exposing terms' associated content to manipulation.

Hierarchy

Expanded class hierarchy of TaxonomyDisplayAssociatedDisplayHandler

File

classes/associated_display.inc, line 6

View source
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()
   */
  public abstract function displayAssociated($term, $options = NULL);

}

Members

Namesort descending Modifiers Type Description Overrides
TaxonomyDisplayAssociatedDisplayHandler::displayAssociated abstract public function Render the output to be displayed when the user views the taxonomy term. 3
TaxonomyDisplayHandlerForm::formFieldset abstract public function Prepare the form that users will configure. 7
TaxonomyDisplayHandlerForm::formSubmit public function Perform any processing desired and return the result to be stored. 7
TaxonomyDisplayHandlerForm::formValidate public function Perform validation on the custom formFieldset when the user submits. 1