Source for file TopicMapSystem.ConfigurableHelperObject.interface.php

Documentation is available at TopicMapSystem.ConfigurableHelperObject.interface.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. /**
  6. * Interface TopicMapSystemConfigurableHelperObjectInterface: An interface for a helper object implementation which requires notification of the TopicMapInterface instance it acts upon.
  7. *
  8. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  9. */
  10. interface TopicMapSystemConfigurableHelperObjectInterface{
  11. /**
  12. * configure: Configuration method of the helper object. The object instance must be guaranteed that this method will always be invoked prior to calls to any other public class method other than constructors.
  13. * @param object TopicMapInterface $tm
  14. * @access public
  15. * @return void
  16. * @throws HelperObjectConfigurationException if the configuration could not be completed for some reason.
  17. * <code>
  18. * public function configure(TopicMapInterface $tm){
  19. * throw new HelperObjectConfigurationException('Exception in '.__method__);
  20. * }
  21. * </code>
  22. */
  23. public function configure(TopicMapInterface $tm);
  24. }
  25. ?>

Documentation generated on Fri, 30 Jun 2006 13:07:09 +0200 by phpDocumentor 1.3.0RC4