Docs For Class ScopedObjectsIndexInterface

Description

Interface ScopedObjectsIndexInterface: An index of all ScopedObjectInterfaces (AssociationInterface, TopicNameInterface, OccurrenceInterface and VariantInterface) instances in the indexed topic map.

Interface ScopedObjectsIndexInterface: An index of all ScopedObjectInterfaces (AssociationInterface, TopicNameInterface, OccurrenceInterface and VariantInterface) instances in the indexed topic map. This index provides methods to retrieve all of the ScopedObjectInterface instances in the topic map with a particular topic or set of topics in their scope, and to retrieve all of the topics used in the scope of one or more scoped objects in the topic map.

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

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

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --ScopedObjectsIndexInterface

Method Summary

array getScopedObjectsByScopingTopic (object TopicInterface $scopingTopic)

array getScopedObjectsByScopingTopics (array $scopingTopics, boolean $matchAll)

array getScopingTopics ()

Methods

getScopedObjectsByScopingTopic (line 18)

getScopedObjectsByScopingTopic: Returns all ScopedObjectInterface instances where the specified topic is one of the themes in the scope of the ScopedObjectInterface.

getScopedObjectsByScopingTopic: Returns all ScopedObjectInterface instances where the specified topic is one of the themes in the scope of the ScopedObjectInterface. The return value may be an empty array but must never be null.

return: - An array of ScopedObjectInterface instances.
access: public

array getScopedObjectsByScopingTopic (object TopicInterface $scopingTopic)

object TopicInterface $scopingTopic: The topic that must be in the scope of each returned ScopedObjectInterface. If $scopingTopic is null an array containing all ScopedObjectInterfaces that have no scope will be returned.

getScopedObjectsByScopingTopics (line 27)

getScopedObjectsByScopingTopics: Returns all ScopedObjectInterface instances where some or all of the specified topics are in the scope of the scoped object.

getScopedObjectsByScopingTopics: Returns all ScopedObjectInterface instances where some or all of the specified topics are in the scope of the scoped object. The return value may be an empty array but must never be null.

return: An array of ScopedObjectInterface instances.
access: public

array getScopedObjectsByScopingTopics (array $scopingTopics, boolean $matchAll)

array $scopingTopics
boolean $matchAll

getScopingTopics (line 34)

getScopingTopics: Returns all TopicInterface instances which are present in the scope of one or more ScopedObjectInterface instances in the indexed topic map.

getScopingTopics: Returns all TopicInterface instances which are present in the scope of one or more ScopedObjectInterface instances 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 getScopingTopics ()

Inherited Methods

Inherited From IndexInterface

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

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()