Source for file TopicsIndex.interface.php

Documentation is available at TopicsIndex.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index.core
  4. */
  5. require_once('../org.phptmapi.index/Index.interface.php');
  6. /**
  7. * Interface TopicsIndexInterface: An index of the topics in the topic map. This index provides methods to retrieve all of the topics in the topic map which are used to define the type of one or more topics in the topic map. The index also provides methods to retrieve all topics with one or more types and to retrieve topics by their reified subject address or subject indicators.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface TopicsIndexInterface extends IndexInterface{
  12. /**
  13. * getTopicsByType: Retrieve the topics in the topic map that include the topic type as one of their types. The return value may be an empty array but must never be null.
  14. * @param object TopicInterface $type The type of the topics to be returned. If type is null an array containing all untyped topics will be returned.
  15. * @access public
  16. * @return array An array of TopicInterface instances.
  17. */
  18. public function getTopicsByType($type);
  19. /**
  20. * getTopicsByType: Retrieve the topics in the topic map that include all of the specified topics amongst their types. The return value may be an empty array but must never be null.
  21. * @param array $types An array of TopicInterface instances.
  22. * @param boolean $matchAll
  23. * @access public
  24. * @return array An array of TopicInterface instances.
  25. */
  26. public function getTopicsByTypes($types, $matchAll);
  27. /**
  28. * getTopicTypes: Retrieve the topics that are used as topic types in the indexed topic map. The return value may be an empty array but must never be null.
  29. * @access public
  30. * @return array An array of TopicInterface instances.
  31. */
  32. public function getTopicTypes();
  33. }
  34. ?>

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