Docs For Class VariantsIndexInterface

Description

Interface VariantsIndexInterface: An index of all VariantInterface instances in the topic map by their resource reference or resource data.

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

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

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --VariantsIndexInterface

Method Summary

array getVariants (string $value, string $datatype)

Methods

getVariants (line 19)

getVariants: Returns the Variants in the topic map whose resource locator matches $loc.

getVariants: Returns the Variants in the topic map whose resource locator matches $loc. The return value may be an empty array but must never be null.

return: An array of VariantInterface instances.
access: public

array getVariants (string $value, string $datatype)

string $value: The variant data string.
string $datatype: An XML Schema Datatype.

Inherited Methods

Inherited From IndexInterface

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

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()