Docs For Class TopicNamesIndexInterface

Description

Interface TopicNamesIndexInterface: This Index gives direct access to all topic names.

Interface TopicNamesIndexInterface: This Index gives direct access to all topic names. You can get all topic names, or a topic name by value.

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

Located in /org.phptmapi.index.core/TopicNamesIndex.interface.php (line 12)

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --TopicNamesIndexInterface

Method Summary

array getTopicNamesByType (object TopicInterface $type)

array getTopicNamesByValue (string $value)

array getTopicNameTypes ()

Methods

getTopicNamesByType (line 19)

getTopicNamesByType: Retrieves the topic names in the indexed topic map whose type is defined by the specified topic.

getTopicNamesByType: Retrieves the topic names in the indexed topic map whose type is defined by the specified topic. The return value may be an empty array but must never be null.

return: An array of TopicNameInterface instances. If the processor does not support the XTM 1.1 model, this method MUST return an empty array.
access: public

array getTopicNamesByType (object TopicInterface $type)

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

getTopicNamesByValue (line 27)

getTopicNamesByValue: Retrieves the topic names in the topic map which have a value equal to $value.

getTopicNamesByValue: Retrieves the topic names in the topic map which have a value equal to $value. The return value may be an empty array but must never be null.

return: An array of TopicNameInterface instances.
access: public

array getTopicNamesByValue (string $value)

string $value

getTopicNameTypes (line 34)

getTopicNameTypes: Retrieves the topics in the topic map which define the type of one or more topic names.

getTopicNameTypes: Retrieves the topics in the topic map which define the type of one or more topic names. The return value may be an empty array but must never be null.

return: - An array of TopicInterface instances. If the processor does not support the XTM 1.1 model, this method MUST return an empty array.
access: public

array getTopicNameTypes ()

Inherited Methods

Inherited From IndexInterface

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

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()