Source for file ReadableLog.php

Documentation is available at ReadableLog.php

  1. <?php
  2. /**
  3. * ReadableLog allows reading of its entries.
  4. *
  5. * <p>
  6. * OSID Version: 2.0
  7. * </p>
  8. *
  9. * <p>
  10. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  11. * O.K.I&#46; OSID Definition License}.
  12. * </p>
  13. *
  14. * @package org.osid.logging
  15. */
  16. class ReadableLog
  17. {
  18. /**
  19. * Get the display name for this ReadableLog.
  20. *
  21. * @return string
  22. *
  23. * @throws object LoggingException An exception with one of the
  24. * following messages defined in org.osid.logging.LoggingException
  25. * may be thrown: {@link }
  26. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  27. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  28. * OPERATION_FAILED}, {@link }
  29. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  30. * CONFIGURATION_ERROR}, {@link }
  31. * org.osid.logging.LoggingException#PERMISSION_DENIED
  32. * PERMISSION_DENIED}
  33. *
  34. * @access public
  35. */
  36. function getDisplayName () {
  37. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  38. }
  39.  
  40. /**
  41. * Return the ReadableLog Entries in a last-in, first-out (LIFO) order.
  42. *
  43. * @param object Type $formatType
  44. * @param object Type $priorityType
  45. *
  46. * @return object EntryIterator
  47. *
  48. * @throws object LoggingException An exception with one of the
  49. * following messages defined in org.osid.logging.LoggingException
  50. * may be thrown: {@link }
  51. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  52. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  53. * OPERATION_FAILED}, {@link }
  54. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  55. * CONFIGURATION_ERROR}, {@link }
  56. * org.osid.logging.LoggingException#PERMISSION_DENIED
  57. * PERMISSION_DENIED}, {@link }
  58. * org.osid.logging.LoggingException#NULL_ARGUMENT NULL_ARGUMENT},
  59. * {@link org.osid.logging.LoggingException#UNKNOWN_TYPE}
  60. * UNKNOWN_TYPE}
  61. *
  62. * @access public
  63. */
  64. function getEntries ( $formatType, $priorityType ) {
  65. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  66. }
  67. }
  68.  
  69. ?>

Documentation generated on Wed, 19 Sep 2007 10:25:45 -0400 by phpDocumentor 1.3.0RC3