Source for file Observer.class.php

Documentation is available at Observer.class.php

  1. <?php
  2. /**
  3. * XOAD Observer file.
  4. *
  5. * <p>This file defines the {@link XOAD_Observer} Class.</p>
  6. * <p>Example:</p>
  7. * <code>
  8. * <?php
  9. *
  10. * require_once('xoad.php');
  11. *
  12. * class CallbackObserver extends XOAD_Observer
  13. * {
  14. * function updateObserver($event, $arg)
  15. * {
  16. * print $event . ' called.';
  17. * }
  18. * }
  19. *
  20. * XOAD_Server::addObserver(new CallbackObserver());
  21. *
  22. * ...
  23. *
  24. * ?>
  25. * </code>
  26. *
  27. * @author Stanimir Angeloff
  28. *
  29. * @package XOAD
  30. *
  31. * @version 0.6.0.0
  32. *
  33. */
  34.  
  35. /**
  36. * XOAD Observer Class.
  37. *
  38. * <p>To observe XOAD events you must define your own
  39. * classes that extend the {@link XOAD_Observer} class.</p>
  40. * <p>See {@link XOAD_Observer::updateObserver} for
  41. * more information.</p>
  42. * <p>Example:</p>
  43. * <code>
  44. * <?php
  45. *
  46. * require_once('xoad.php');
  47. *
  48. * class CallbackObserver extends XOAD_Observer
  49. * {
  50. * function updateObserver($event, $arg)
  51. * {
  52. * print $event . ' called.';
  53. * }
  54. * }
  55. *
  56. * XOAD_Server::addObserver(new CallbackObserver());
  57. *
  58. * ...
  59. *
  60. * ?>
  61. * </code>
  62. *
  63. * @author Stanimir Angeloff
  64. *
  65. * @package XOAD
  66. *
  67. * @version 0.6.0.0
  68. *
  69. */
  70. class XOAD_Observer
  71. {
  72. /**
  73. * This method is called when {@link XOAD_Observable::notifyObservers}
  74. * is called.
  75. *
  76. * <p>You should override this method to accept two parameters - the
  77. * event name and the event argument.</p>
  78. * <p>If {@link XOAD_Observable::notifyObservers} is called without
  79. * parameters the event name is 'default'.</p>
  80. * <p>You should also always return a boolean value that indicates
  81. * the result of the event.</p>
  82. *
  83. * @access public
  84. *
  85. * @return bool Always true.
  86. *
  87. */
  88. function updateObserver()
  89. {
  90. return true;
  91. }
  92. }
  93.  
  94. ?>

Documentation generated on Sat, 12 Nov 2005 20:24:27 +0200 by phpDocumentor 1.3.0RC3