Source for file VariantsIndex.interface.php

Documentation is available at VariantsIndex.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index.core
  4. */
  5. require_once('../org.phptmapi.index/Index.interface.php');
  6. /**
  7. * Interface VariantsIndexInterface: An index of all VariantInterface instances in the topic map by their resource reference or resource data.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface VariantsIndexInterface extends IndexInterface{
  12. /**
  13. * getVariants: Returns the Variants in the topic map whose resource locator matches $loc. The return value may be an empty array but must never be null.
  14. * @param string $value The variant data string.
  15. * @param string $datatype An XML Schema Datatype.
  16. * @access public
  17. * @return array An array of VariantInterface instances.
  18. */
  19. public function getVariants($value, $datatype);
  20. }
  21. ?>

Documentation generated on Fri, 30 Jun 2006 13:07:20 +0200 by phpDocumentor 1.3.0RC4