Docs For Class TopicsIndexInterface

Description

Interface TopicsIndexInterface: An index of the topics in the topic map.

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.

author: Johannes Schmidt - t8d <kontakt@t8d.de>

Located in /org.phptmapi.index.core/TopicsIndex.interface.php (line 11)

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --TopicsIndexInterface

Method Summary

array getTopicsByType (object TopicInterface $type)

array getTopicsByTypes (array $types, boolean $matchAll)

array getTopicTypes ()

Methods

getTopicsByType (line 18)

getTopicsByType: Retrieve the topics in the topic map that include the topic type as one of their types.

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.

return: An array of TopicInterface instances.
access: public

array getTopicsByType (object TopicInterface $type)

object TopicInterface $type: The type of the topics to be returned. If type is null an array containing all untyped topics will be returned.

getTopicsByTypes (line 27)

getTopicsByType: Retrieve the topics in the topic map that include all of the specified topics amongst their types.

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.

return: An array of TopicInterface instances.
access: public

array getTopicsByTypes (array $types, boolean $matchAll)

array $types: An array of TopicInterface instances.
boolean $matchAll

getTopicTypes (line 34)

getTopicTypes: Retrieve the topics that are used as topic types in the indexed topic map.

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.

return: An array of TopicInterface instances.
access: public

array getTopicTypes ()

Inherited Methods

Inherited From IndexInterface

IndexInterface::close()
IndexInterface::getFlags()
IndexInterface::isAutoUpdated()
IndexInterface::isOpen()
IndexInterface::open()
IndexInterface::reindex()

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()