Interface Scoped

Description

Indicates that a statement (Topic Maps construct) has a scope.

Indicates that a statement (Topic Maps construct) has a scope. Associations, Occurrences, Names, and IVariants are scoped.

Located in /core/Scoped.interface.php (line 25)

Construct
   |
   --Scoped
Method Summary
void addTheme (Topic $theme)
array getScope ()
void removeTheme (Topic $theme)
Methods
addTheme (line 43)

Adds a Topic to the scope.

Adds a Topic to the scope.

  • access: public
void addTheme (Topic $theme)
  • Topic $theme: The topic which should be added to the scope.
getScope (line 35)

Returns the Topics which define the scope.

Returns the Topics which define the scope. An empty array represents the unconstrained scope. The return value may be an empty array but must never be null.

  • return: An array containing a set of Topics which define the scope.
  • access: public
array getScope ()
removeTheme (line 51)

Removes a Topic from the scope.

Removes a Topic from the scope.

  • access: public
void removeTheme (Topic $theme)
  • Topic $theme: The topic which should be removed from the scope.

Inherited Methods

Inherited From Construct

Construct::addItemIdentifier()
Construct::equals()
Construct::getId()
Construct::getItemIdentifiers()
Construct::getParent()
Construct::getTopicMap()
Construct::hashCode()
Construct::remove()
Construct::removeItemIdentifier()

Documentation generated on Sat, 15 Jan 2011 20:02:26 +0100 by phpDocumentor 1.4.1