Docs For Class ScopedObjectInterface

Description

Interface ScopedObjectInterface: The base class for all objects which define a scope or parameter property.

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

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

TopicMapObjectInterface
   |
   --ScopedObjectInterface

Direct descendents

Class	Description
AssociationInterface	Interface AssociationInterface: Represents the topic map association construct.
OccurrenceInterface	Interface OccurrenceInterface: Represents the topic map occurrence construct.
TopicNameInterface	Interface TopicNameInterface: Represents the topic map topicname construct.
VariantInterface	Interface VariantInterface: Represents the topic map variant name construct.

Method Summary

void addScopingTopic (TopicInterface $topic)

array getScope ()

void removeScopingTopic (TopicInterface $topic)

Methods

addScopingTopic (line 25)

addScopingTopic: Adds a topic which defines the scope/parameters for this ScopedObjectInterface.

access: public

void addScopingTopic (TopicInterface $topic)

object TopicInterface $topic: The topic to be added.

getScope (line 17)

getScope: Returns the topics which define the scope/parameters of this ScopedObjectInterface.

getScope: Returns the topics which define the scope/parameters of this ScopedObjectInterface. The return value may be an empty array, but is never null.

return: An unmodifiable array of TopicInterface objects.
access: public

array getScope ()

removeScopingTopic (line 33)

removeScopingTopic: Removes a topic which defines the scope/parameters for this ScopedObjectInterface.

access: public

void removeScopingTopic (TopicInterface $topic)

object TopicInterface $topic: The topic to be removed.

Inherited Methods

Inherited From TopicMapObjectInterface

TopicMapObjectInterface::addItemIdentifier()
TopicMapObjectInterface::getItemIdentifiers()
TopicMapObjectInterface::getObjectId()
TopicMapObjectInterface::getParent()
TopicMapObjectInterface::getTopicMap()
TopicMapObjectInterface::remove()
TopicMapObjectInterface::removeItemIdentifier()