Interface ScopedIndex

Description

Index for Scoped statements and their scope.

Index for Scoped statements and their scope. This index provides access to Associations, Occurrences, Names, and IVariants by their scope property and to Topics which are used as theme in a scope.

Located in /index/ScopedIndex.interface.php (line 26)

Index
   |
   --ScopedIndex
Method Summary
array getAssociations ( $themes, boolean $matchAll)
array getNames ( $themes, boolean $matchAll)
array getNameThemes ()
array getOccurrences ( $themes, boolean $matchAll)
array getVariants ( $themes, boolean $matchAll)
array getVariantThemes ()
Methods
getAssociations (line 46)

Returns the Associations in the topic map whose scope property equals one of those themes at least.

Returns the Associations in the topic map whose scope property equals one of those themes at least. If themes' length == 1, $matchAll is interpreted true. If themes' length == 0, $themes is interpreted as the unconstrained scope. The return value may be an empty array but must never be null.

  • return: An array containing Associations.
  • throws: InvalidArgumentException If $themes does not exclusively contain Topics.
  • access: public
array getAssociations ( $themes, boolean $matchAll)
  • array $themes: The scope of the Associations to be returned. If $themes is an empty array all Associations in the unconstrained scope are returned.
  • boolean $matchAll: If true the scope property of an association must match all themes, if false one theme must be matched at least. If themes' length == 1, $matchAll is interpreted true.
getAssociationThemes (line 55)

Returns the Topics in the topic map used in the scope property of Associations.

Returns the Topics in the topic map used in the scope property of Associations. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getAssociationThemes ()
getNames (line 75)

Returns the Names in the topic map whose scope property equals one of those themes at least.

Returns the Names in the topic map whose scope property equals one of those themes at least. If themes' length == 1, $matchAll is interpreted true. If themes' length == 0, $themes is interpreted as the unconstrained scope. The return value may be an empty array but must never be null.

  • return: An array containing Names.
  • throws: InvalidArgumentException If $themes does not exclusively contain Topics.
  • access: public
array getNames ( $themes, boolean $matchAll)
  • array $themes: The scope of the Names to be returned. If $themes is an empty array all Names in the unconstrained scope are returned.
  • boolean $matchAll: If true the scope property of a name must match all themes, if false one theme must be matched at least. If themes' length == 1, $matchAll is interpreted true.
getNameThemes (line 84)

Returns the Topics in the topic map used in the scope property of Names.

Returns the Topics in the topic map used in the scope property of Names. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getNameThemes ()
getOccurrences (line 104)

Returns the Occurrences in the topic map whose scope property equals one of those themes at least.

Returns the Occurrences in the topic map whose scope property equals one of those themes at least. If themes' length == 1, $matchAll is interpreted true. If themes' length == 0, $themes is interpreted as the unconstrained scope. The return value may be an empty array but must never be null.

  • return: An array containing Occurrences.
  • throws: InvalidArgumentException If $themes does not exclusively contain Topics.
  • access: public
array getOccurrences ( $themes, boolean $matchAll)
  • array $themes: The scope of the Occurrences to be returned. If $themes is an empty array all Occurrences in the unconstrained scope are returned.
  • boolean $matchAll: If true the scope property of a name must match all themes, if false one theme must be matched at least. If themes' length == 1, $matchAll is interpreted true.
getOccurrenceThemes (line 113)

Returns the Topics in the topic map used in the scope property of Occurrences.

Returns the Topics in the topic map used in the scope property of Occurrences. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getOccurrenceThemes ()
getVariants (line 129)

Returns the IVariants in the topic map whose scope property equals one of those themes at least.

Returns the IVariants in the topic map whose scope property equals one of those themes at least. If themes' length == 1, $matchAll is interpreted true. The return value may be an empty array but must never be null.

  • return: An array containing IVariants.
  • throws: InvalidArgumentException If $themes is an empty array, or if $themes does not exclusively contain Topics.
  • access: public
array getVariants ( $themes, boolean $matchAll)
  • array $themes: The scope of the IVariants to be returned.
  • boolean $matchAll: If true the scope property of a name must match all themes, if false one theme must be matched at least. If themes' length == 1, $matchAll is interpreted true.
getVariantThemes (line 138)

Returns the Topics in the topic map used in the scope property of IVariants.

Returns the Topics in the topic map used in the scope property of IVariants. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getVariantThemes ()

Inherited Methods

Inherited From Index

Index::close()
Index::isAutoUpdated()
Index::isOpen()
Index::open()
Index::reindex()

Documentation generated on Mon, 19 Sep 2011 21:01:27 +0200 by phpDocumentor 1.4.0